| Les deux révisions précédentesRévision précédenteProchaine révision | Révision précédente |
| guide_du_developpeur_capture [2025/10/20 15:25] – [Conditions pour faire fonctionner ID360 dans une WebView] admin | guide_du_developpeur_capture [2026/01/12 16:38] (Version actuelle) – modification externe 127.0.0.1 |
|---|
| - **Connexion à l’API** : Cet appel vous fournira un token valide pendant 15 minutes, vous permettant d’accéder aux différentes méthodes de l’API. | - **Connexion à l’API** : Cet appel vous fournira un token valide pendant 15 minutes, vous permettant d’accéder aux différentes méthodes de l’API. |
| - **Création d’un dossier utilisateur** : Lors de la création d’un dossier utilisateur, vous recevrez un identifiant de dossier ainsi qu'une clé API (api_key), qui sera essentielle pour la suite du processus. | - **Création d’un dossier utilisateur** : Lors de la création d’un dossier utilisateur, vous recevrez un identifiant de dossier ainsi qu'une clé API (api_key), qui sera essentielle pour la suite du processus. |
| - **Comparaison de données (optionnelle)** : Il est également possible de comparer des données attendues avec celles extraites de l'identité. | - **Comparaison de données (en option)** : Il est également possible de comparer des données attendues avec celles extraites de l'identité. |
| - **Redirection de l’utilisateur vers l’interface utilisateur (UI)** : La clé API obtenue à l’étape précédente vous permettra de rediriger l’utilisateur vers son parcours d’enrôlement. | - **Redirection de l’utilisateur vers l’interface utilisateur (UI)** : La clé API obtenue à l’étape précédente vous permettra de rediriger l’utilisateur vers son parcours d’enrôlement. |
| - **Récupération du rapport** : Vous pourrez récupérer le rapport du dossier utilisateur en utilisant l'identifiant du dossier obtenu lors de la deuxième étape. Ce rapport contiendra le statut du dossier ainsi que des informations techniques et sur les différentes étapes de vérification. | - **Récupération du rapport** : Vous pourrez récupérer le rapport du dossier utilisateur en utilisant l'identifiant du dossier obtenu lors de la deuxième étape. Ce rapport contiendra le statut du dossier ainsi que des informations techniques et sur les différentes étapes de vérification. |
| |
| === 🔧 Options et outils complémentaires === | === 🔧 Options et outils complémentaires === |
| * **Faire fonctionner ID360 dans une webview (optionel)** : hors parcours proposant l'Identité Numérique La Poste | * **Faire fonctionner ID360 dans une webview (en option)** : hors parcours proposant l'Identité Numérique La Poste |
| * **Health monitoring** | * **Interrompre un dossier** : Pour invalider une URL d'identification et forcer la clôture d'un dossier dans le cas d'un parcours non démarré ou incomplet. |
| |
| ---- | ---- |
| "country": "Users country", | "country": "Users country", |
| "phone_number": "Users phone number", | "phone_number": "Users phone number", |
| "group": "string" | "group": "string", |
| | /* Seulement pour les parcours avec génération d'idclaim */ |
| | "custom_data": { |
| | "authenticators" : { |
| | "phone_number" : "+33668001418" |
| | } |
| | } |
| } | } |
| </code> | </code> |
| * **''client_reference''** : facultatif – Permet d’associer un identifiant interne à votre système. Utile pour les croisements en cas d’annulation ou d’échec. | * **''client_reference''** : facultatif – Permet d’associer un identifiant interne à votre système. Utile pour les croisements en cas d’annulation ou d’échec. |
| * **''callback_endpoints''** : obligatoire – un callback endpoint permet à ID360 de notifier automatiquement votre système lorsqu’un dossier atteint un certain statut (ex. échec, annulation, fin de traitement), via une requête HTTP POST envoyée à l’URL que vous avez fournie. Les headers sont optionnels, vous pouvez les utiliser comme des headers d'identification lors de la réception des callbacks. | * **''callback_endpoints''** : obligatoire – un callback endpoint permet à ID360 de notifier automatiquement votre système lorsqu’un dossier atteint un certain statut (ex. échec, annulation, fin de traitement), via une requête HTTP POST envoyée à l’URL que vous avez fournie. Les headers sont optionnels, vous pouvez les utiliser comme des headers d'identification lors de la réception des callbacks. |
| | * **''custom_data''> ''authenticators'' > ''phone_number''** : obligatoire dans le cadre de la génération d'un **idclaim**. |
| * **''last_name, first_name, address_line_1/2/3, zip_code, city, country, phone_number, email''** : facultatifs – Informations utilisateur à titre **informatif uniquement** (aucun contrôle réalisé dessus). | * **''last_name, first_name, address_line_1/2/3, zip_code, city, country, phone_number, email''** : facultatifs – Informations utilisateur à titre **informatif uniquement** (aucun contrôle réalisé dessus). |
| * **''group''** : facultatif – permettra de faire un export des consommations en fonction de groupes. | * **''group''** : facultatif – permettra de faire un export des consommations en fonction de groupes. |
| "https://id360docaposte.com/api/1.0.0/enrollment/{id}/control/data/{data_name}/?locked=true" \ | "https://id360docaposte.com/api/1.0.0/enrollment/{id}/control/data/{data_name}/?locked=true" \ |
| -H "accept: application/json" \ | -H "accept: application/json" \ |
| -H "Authorization: Token 0123456789abcdef01234567" | -H "Authorization: Token 0123456789abcdef01234567" \ |
| | -H "Content-Type: text/plain" |
| </code> | </code> |
| |
| "https://preprod.id360docaposte.com/api/1.0.0/enrollment/{id}/control/data/{data_name}/?locked=true" \ | "https://preprod.id360docaposte.com/api/1.0.0/enrollment/{id}/control/data/{data_name}/?locked=true" \ |
| -H "accept: application/json" \ | -H "accept: application/json" \ |
| -H "Authorization: Token 0123456789abcdef01234567" | -H "Authorization: Token 0123456789abcdef01234567" \ |
| | -H "Content-Type: text/plain" |
| </code> | </code> |
| |
| Notez qu'il s'agit d'une empreinte de l'enrôlement et non d'un rapport d’identification comme celui obtenu via le paramètre « report » (un exemple est disponible dans le swagger). | Notez qu'il s'agit d'une empreinte de l'enrôlement et non d'un rapport d’identification comme celui obtenu via le paramètre « report » (un exemple est disponible dans le swagger). |
| |
| Même si vous n’utilisez pas ce token, le statut du dossier sera communiqué via l’URL de callback (voir l’étape suivante). | Même si vous n’utilisez pas ce token, le statut du dossier sera communiqué via l’URL de callback (voir [[https://wiki.id360docaposte.com/doku.php?id=guide_callbacks|le guide de callback]]). |
| |
| |
| |
| **HTTP Status** : ''200 OK'' | **HTTP Status** : ''200 OK'' |
| | |
| **Format de la réponse** : JSON | **Format de la réponse** : JSON |
| |
| |
| |
| ====== 8. Récupération de l'idClaim ====== | ====== 7. Récupération de l'idClaim ====== |
| |
| [[https://preprod.id360docaposte.com/static/swagger.html#/enrollment/enrollment_idclaim|Voir la méthode dans le Swagger]] | [[https://preprod.id360docaposte.com/static/swagger.html#/enrollment/enrollment_idclaim|Voir la méthode dans le Swagger]] |
| </code> | </code> |
| |
| | ====== Conditions pour faire fonctionner ID360 dans une WebView ====== |
| | Les permissions suivantes doivent être activées côté application (Android ou iOS) : |
| | * Accès à la caméra |
| | * Accès au gyromètre |
| | * Accès aux fichiers (pour l’import de documents) |
| | Et également : |
| | * Activer le JavaScript |
| | * Sur Android, initialiser la WebView avec l’**activity context** (et non le context global de l’application), pour assurer le bon fonctionnement des éléments comme les menus déroulants. |
| | |
| | ====== Interrompre un dossier ====== |
| | |
| | [[https://preprod.id360docaposte.com/static/swagger.html#/Enrollment%20Control/control_discontinue|Voir la méthode dans le Swagger]] |
| | |
| | ---- |
| | |
| | === 🔧 Requête CURL – Production === |
| | <code javascript> |
| | curl -X GET \ |
| | "https://id360docaposte.com/api/1.0.0/enrollment/{id}/control/discontinue" \ |
| | -H "Authorization: Token 0123456789abcdef01234567" |
| | </code> |
| | |
| | ---- |
| | |
| | === 🔧 Requête CURL – Préproduction === |
| | <code javascript> |
| | curl -X GET \ |
| | "https://preprod.id360docaposte.com/api/1.0.0/enrollment/{id}/control/discontinue" \ |
| | -H "Authorization: Token 0123456789abcdef01234567" |
| | </code> |
| | |
| | ---- |
| | |
| | === 🛠 Informations techniques === |
| | |
| | * **''{id}''** : identifiant du dossier utilisateur, récupéré lors de sa création. |
| | * **Paramètres** : aucun paramètre attendu dans cette requête. |
| | |
| | ---- |
| | |
| | === ✅ Résultat attendu === |
| | |
| | **HTTP Status** : ''204 No Content'' |
| | |
| | ---- |
| | |
| | === 💬 Commentaires === |
| | |
| | Le statut du dossier sera changé en DISCONTINUED |
| |
