| Les deux révisions précédentesRévision précédenteProchaine révision | Révision précédente |
| guide_du_developpeur_capture [2025/10/22 10:38] – [Annuler un dossier] admin | guide_du_developpeur_capture [2026/01/26 14:44] (Version actuelle) – admin |
|---|
| === 🔧 Options et outils complémentaires === | === 🔧 Options et outils complémentaires === |
| * **Faire fonctionner ID360 dans une webview (en option)** : 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 |
| * **Annuler 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. | * **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. |
| |
| ---- | ---- |
| |
| ^ Paramètre ^ Obligatoire ^ Détails ^ | ^ Paramètre ^ Obligatoire ^ Détails ^ |
| | ''username'' | Oui | Identifiant de connexion | | | ''username'' | Oui | Identifiant de connexion (par défaut le login de l'application) | |
| | ''password'' | Oui | Mot de passe associé | | | ''password'' | Oui | Mot de passe associé | |
| | ''token'' | Non (sauf si admin) | Inutile pour les comptes ''application''. Obligatoire uniquement pour les comptes ''admin'' avec authentification à deux facteurs. | | | ''token'' | Non (sauf si admin) | Inutile pour les comptes ''application''. Obligatoire uniquement pour les comptes ''admin'' avec authentification à deux facteurs. | |
| "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. |
| |
| > Pour plus de détails sur les callback_endpoints, consultez [[https://wiki.id360docaposte.com/doku.php?id=guide_callbacks|ce guide dédié]]. | > Pour plus de détails sur les callback_endpoints, consultez [[https://id360.doca-id.com/doku.php?id=guide_callbacks|ce guide dédié]]. |
| |
| ---- | ---- |
| Dans la configuration du parcours, il est indispensable de sélectionner **au moins une donnée à comparer**. | Dans la configuration du parcours, il est indispensable de sélectionner **au moins une donnée à comparer**. |
| Pour ce faire, accédez au bloc **''Saisie d'informations''** et choisissez les éléments à comparer. | Pour ce faire, accédez au bloc **''Saisie d'informations''** et choisissez les éléments à comparer. |
| | |
| | Ensuite, sous le bloc **''Sélection des contrôles''**, cliquez sur **''Idenitité''** et cochez les contrôles que vous désirez. |
| | Par exemple "Vérifier la coherence du nom d'usage avec l'identité". |
| |
| [[https://preprod.id360docaposte.com/static/swagger.html#/Enrollment%20Control/control_data|Voir la méthode dans le Swagger]] | [[https://preprod.id360docaposte.com/static/swagger.html#/Enrollment%20Control/control_data|Voir la méthode dans le Swagger]] |
| "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://id360.doca-id.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 |
| |
| |
| ====== Interrompre un dossier ====== | ====== 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 |