Outils pour utilisateurs

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentesRévision précédente
Prochaine révision
Révision précédente
guide_du_developpeur_full_api [2025/05/14 09:01] – [1.1 Connexion à l’API : Authentification] adminguide_du_developpeur_full_api [2025/06/19 10:40] (Version actuelle) – admin
Ligne 1: Ligne 1:
-====== Guide du dĂ©veloppeur full API ======+====== Guide du dĂ©veloppeur - ID360 Service ======
  
 === 🎯 La solution ID360 vous permettra de :=== === 🎯 La solution ID360 vous permettra de :===
Ligne 48: Ligne 48:
   -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 ===
Ligne 164: Ligne 162:
 curl -X POST \ curl -X POST \
   "https://id360docaposte.com/api/1.0.0/process/{id}/enrollment" \   "https://id360docaposte.com/api/1.0.0/process/{id}/enrollment" \
-  -H "accept: application/json" \ 
   -H "Authorization: Token 0123456789abcdef01234567"   -H "Authorization: Token 0123456789abcdef01234567"
 </code> </code>
Ligne 174: Ligne 171:
 curl -X POST \ curl -X POST \
   "https://preprod.id360docaposte.com/api/1.0.0/process/{id}/enrollment" \   "https://preprod.id360docaposte.com/api/1.0.0/process/{id}/enrollment" \
-  -H "accept: application/json" \ 
   -H "Authorization: Token 0123456789abcdef01234567"   -H "Authorization: Token 0123456789abcdef01234567"
 </code> </code>
Ligne 191: Ligne 187:
 <code json> <code json>
 { {
-  "callback_url": "https://www.example.com/callback_url", 
   "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",
Ligne 207: Ligne 211:
   "city": "Users city",   "city": "Users city",
   "country": "Users country",   "country": "Users country",
-  "phone_number": "Users phone number"+  "phone_number": "Users phone number", 
 +  "group": "string"
 } }
 </code> </code>
Ligne 215: Ligne 220:
 === 📝 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Ă©]].
  
 ---- ----
Ligne 236: Ligne 240:
   "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",
Ligne 243: Ligne 246:
   "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>
Ligne 279: Ligne 291:
   -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 ===
Ligne 331: Ligne 341:
   -H "Content-Type: text/plain"   -H "Content-Type: text/plain"
 </code> </code>
- 
----- 
  
 === 🔧 RequĂȘte CURL – PrĂ©production === === 🔧 RequĂȘte CURL – PrĂ©production ===
Ligne 377: Ligne 385:
   -d ''   -d ''
 </code> </code>
- 
----- 
  
 === 🔧 RequĂȘte CURL – PrĂ©production === === 🔧 RequĂȘte CURL – PrĂ©production ===
Ligne 419: Ligne 425:
   -H "Authorization: Token 0123456789abcdef01234567"   -H "Authorization: Token 0123456789abcdef01234567"
 </code> </code>
- 
----- 
  
 === 🔧 RequĂȘte CURL – PrĂ©production === === 🔧 RequĂȘte CURL – PrĂ©production ===
Ligne 621: Ligne 625:
 === 🔧 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" \
Ligne 631: Ligne 635:
 === 🔧 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" \

This website uses cookies. By using the website, you agree with storing cookies on your computer. Also, you acknowledge that you have read and understand our Privacy Policy. If you do not agree, please leave the website.

Plus d’informations