| Les deux révisions précédentesRévision précédenteProchaine révision | Révision précédente |
| guide_du_developpeur_full_api [2025/05/14 09:23] â [2. CrĂ©ation dâun dossier utilisateur] admin | guide_du_developpeur_full_api [2025/06/19 10:40] (Version actuelle) â admin |
|---|
| ====== Guide du développeur full API ====== | ====== Guide du développeur - ID360 Service ====== |
| |
| === đŻ La solution ID360 vous permettra de :=== | === đŻ La solution ID360 vous permettra de :=== |
| -d '{ "username": "string", "password": "string", "token": "string" }' | -d '{ "username": "string", "password": "string", "token": "string" }' |
| </code> | </code> |
| |
| ---- | |
| |
| === đ§ RequĂȘte CURL â PrĂ©production === | === đ§ RequĂȘte CURL â PrĂ©production === |
| <code json> | <code json> |
| { | { |
| "callback_url": "https://www.example.com/callback_url1", | |
| "browser_callback_url": "https://www.example.com/browser_callback_url", | "browser_callback_url": "https://www.example.com/browser_callback_url", |
| "client_reference": "any_string", | "client_reference": "any_string", Â |
| | "callback_endpoints": [{Â |
| | "url": "https://www.example.com/callback_url1", |
| | "on": ["E","F","C"], |
| | "headers": [{"name": "string", "value": "string"}]Â |
| | },{Â |
| | "url": "https://www.example.com/callback_url2", |
| | "on": [], |
| | "headers": [{"name": "string", "value": "string"}]Â |
| | }], |
| "callback_headers": { | "callback_headers": { |
| "header_name_1": "header_value_1", | "header_name_1": "header_value_1", |
| "country": "Users country", | "country": "Users country", |
| "phone_number": "Users phone number", | "phone_number": "Users phone number", |
| "group": "string", | "group": "string" |
| "callback_endpoints": [Â | |
| {Â | |
| "url": "string", | |
| "on": [Â | |
| "F"Â | |
| ], | |
| "headers": [Â | |
| {Â | |
| "name": "string", | |
| "value": "string"Â | |
| }Â | |
| ]Â | |
| }Â | |
| ] | |
| } | } |
| </code> | </code> |
| === đ DĂ©tails des champs === | === đ DĂ©tails des champs === |
| |
| * **''callback_url''** : obligatoire â URL de votre serveur appelĂ©e par ID360 en POST une fois lâenrĂŽlement traitĂ©. | |
| * **''browser_callback_url''** : obligatoire â URL appelĂ©e par le navigateur de lâutilisateur Ă la fin du parcours (utilisĂ©e uniquement pour la redirection). | * **''browser_callback_url''** : obligatoire â URL appelĂ©e par le navigateur de lâutilisateur Ă la fin du parcours (utilisĂ©e uniquement pour la redirection). |
| * **''callback_headers''** : facultatif â Permet de spĂ©cifier des headers, comme un header dâauthentification, pour lâappel Ă ''callback_url''. | |
| * **''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. |
| * **''last_name, first_name, address_line_1/2/3, zip_code, city, country, phone_number''** : facultatifs â Informations utilisateur Ă titre **informatif uniquement** (aucun contrĂŽle rĂ©alisĂ© dessus). | * **''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. |
| * **''email''** : facultatif â Obligatoire **uniquement** si lâutilisateur doit faire un parcours PVID. | * **''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. |
| |
| đ Pour plus de dĂ©tails sur la ''callback_url'', 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://wiki.id360docaposte.com/doku.php?id=guide_callbacks|ce guide dĂ©diĂ©]]. |
| |
| ---- | ---- |
| "process": 1, | "process": 1, |
| "api_key": "0123456789abcdef0123456789abcde", | "api_key": "0123456789abcdef0123456789abcde", |
| "callback_url": "xxx", | |
| "browser_callback_url": "yyy", | "browser_callback_url": "yyy", |
| "client_reference": "any_string", | "client_reference": "any_string", |
| "creation_time": "2021-12-17T15:01:49.013906", | "creation_time": "2021-12-17T15:01:49.013906", |
| "starting_time": null, | "starting_time": null, |
| "finished_time": null | "finished_time": null;Â |
| | "callback_endpoints": [{Â |
| | "url": "https://dev.webhook.id360docaposte.com/66b905f6-ac91-4a2c-8b1b-752d2393ac3b", |
| | "on": ["E","F","C"], |
| | "headers": [{"name": "string"}]Â |
| | },{Â |
| | "url": "https://dev.webhook.id360docaposte.com/66b905f6-ac91-4a2c-8b1b-752d2393ac3b", |
| | "on": [], |
| | "headers": [{"name": "string"}]Â |
| | }] |
| } | } |
| </code> | </code> |
| -H "x-api-key: <votre_api_key>" | -H "x-api-key: <votre_api_key>" |
| </code> | </code> |
| |
| ---- | |
| |
| === đ§ RequĂȘte CURL â PrĂ©production === | === đ§ RequĂȘte CURL â PrĂ©production === |
| -H "Content-Type: text/plain" | -H "Content-Type: text/plain" |
| </code> | </code> |
| |
| ---- | |
| |
| === đ§ RequĂȘte CURL â PrĂ©production === | === đ§ RequĂȘte CURL â PrĂ©production === |
| -d '' | -d '' |
| </code> | </code> |
| |
| ---- | |
| |
| === đ§ RequĂȘte CURL â PrĂ©production === | === đ§ RequĂȘte CURL â PrĂ©production === |
| -H "Authorization: Token 0123456789abcdef01234567" | -H "Authorization: Token 0123456789abcdef01234567" |
| </code> | </code> |
| |
| ---- | |
| |
| === đ§ RequĂȘte CURL â PrĂ©production === | === đ§ RequĂȘte CURL â PrĂ©production === |
| === đ§ RequĂȘte CURL â Production === | === đ§ RequĂȘte CURL â Production === |
| <code javascript> | <code javascript> |
| curl -X POST \ | curl -X GET \ |
| "https://id360docaposte.com/api/1.0.0/enrollment/{id}/report" \ | "https://id360docaposte.com/api/1.0.0/enrollment/{id}/report" \ |
| -H "accept: application/json" \ | -H "accept: application/json" \ |
| === đ§ RequĂȘte CURL â PrĂ©production === | === đ§ RequĂȘte CURL â PrĂ©production === |
| <code javascript> | <code javascript> |
| curl -X POST \ | curl -X GET \ |
| "https://preprod.id360docaposte.com/api/1.0.0/enrollment/{id}/report" \ | "https://preprod.id360docaposte.com/api/1.0.0/enrollment/{id}/report" \ |
| -H "accept: application/json" \ | -H "accept: application/json" \ |