Différences
Ci-dessous, les différences entre deux révisions de la page.
| Les deux révisions précédentesRévision précédenteProchaine révision | Révision précédente | ||
| guide_callbacks [2025/05/14 09:30] – [LES CALLBACKS ENDPOINTS] admin | guide_callbacks [2025/10/08 10:56] (Version actuelle) – [🔁 Callbacks – À quoi servent-ils ?] admin | ||
|---|---|---|---|
| Ligne 1: | Ligne 1: | ||
| + | [[: | ||
| + | ---- | ||
| + | |||
| ====== INTRODUCTION AUX CALLBACKS ====== | ====== INTRODUCTION AUX CALLBACKS ====== | ||
| - | ==== LES CALLBACKS, DE QUOI S’AGIT-IL | + | ==== 🔁 Callbacks – À quoi servent-ils ? ==== |
| - | Lors de la création d'un dossier, il est essentiel | + | |
| + | Lors de la création d’un dossier, il est indispensable | ||
| + | |||
| + | Chaque callback_endpoint recevra | ||
| + | |||
| + | === 📌 Que peut-on configurer ? === | ||
| + | |||
| + | Vous avez la possibilité de renseigner **une ou plusieurs | ||
| + | |||
| + | * **Callback finale uniquement** : vous recevez une seule notification à la fin du processus, indiquant que l’identification est terminée, avec les informations | ||
| + | * **Callbacks intermédiaires + finale** : vous êtes notifiés à chaque étape clé du parcours utilisateur (début, upload, validation des documents, etc.), en plus de la notification finale. | ||
| + | |||
| + | === ⚠️ Attention à l’ordre d’arrivée des callbacks === | ||
| + | |||
| + | Il est important de noter que dans certains cas, **des callbacks intermédiaires peuvent arriver après la callback finale**. | ||
| + | Cela peut se produire si l’envoi initial d’une callback a échoué (par exemple si votre serveur était temporairement indisponible) : ID360 effectuera alors des **re-tentatives automatiques (retries)** pour garantir la bonne réception. | ||
| - | **Les callbacks intermédiaires** vous permettront d’être notifié pour chaque étape accomplie par l' | + | Ces retries peuvent provoquer un **désalignement temporel |
| - | Enfin, | + | |
| - | Vous avez la possibilité de choisir de recevoir des callbacks seulement en fonction du statut du dossier, ce sont les **callback_endpoints**. | ||
| ==== LA CONSTRUCTION DU PAYLOAD ==== | ==== LA CONSTRUCTION DU PAYLOAD ==== | ||
| Ligne 37: | Ligne 54: | ||
| La valeur **done = 1** signifie que seule l’étape ProfileDataStep (qui était de pousser le nom de famille par API) a été finalisée. | La valeur **done = 1** signifie que seule l’étape ProfileDataStep (qui était de pousser le nom de famille par API) a été finalisée. | ||
| - | Le champ **enrollment_step** fournit des informations détaillées sur l’étape, notamment le résultat du contrôle, le type de vérification effectuée, ainsi que la liste des documents concernés. | + | Le champ **enrollment_step** fournit des informations détaillées sur l’étape, notamment le résultat du contrôle, le type de vérification effectuée, ainsi que la liste des documents concernés. Le statut présent dans enrollment_step peut être OK, KO, FAILED, USER_PROCESSING, |
| **Le type présent dans la variable enrollment_step est une information interne, à ce titre, il ne doit pas être utilisé ou exploité.** | **Le type présent dans la variable enrollment_step est une information interne, à ce titre, il ne doit pas être utilisé ou exploité.** | ||
| Ligne 46: | Ligne 63: | ||
| ^ ‘enrollment_step’ > ‘name’ ^ Document(s) ^ Contrôle / Remarque ^ | ^ ‘enrollment_step’ > ‘name’ ^ Document(s) ^ Contrôle / Remarque ^ | ||
| | id_document | Pièce d’identité | La pièce d’identité a bien été reçue et lue par ID360 | | | id_document | Pièce d’identité | La pièce d’identité a bien été reçue et lue par ID360 | | ||
| - | | id_document_mandat | + | | id_document_mandate |
| | fake_photo_id| Pièce d’identité | La photo présente sur la pièce d’identité est conforme | | | fake_photo_id| Pièce d’identité | La photo présente sur la pièce d’identité est conforme | | ||
| - | | phone_detection | Pièce d’identité | La détection d’attaque par présentation s’est bien déroulée | | + | | phone_detection | Pièce d’identité | La détection d’attaque par présentation s’est bien déroulée | |
| + | | image_forensics | Pièce d’identité | La détection de la monochromie s’est bien déroulée | | ||
| === Moyens d’identification électronique === | === Moyens d’identification électronique === | ||
| Ligne 94: | Ligne 112: | ||
| Dans le steps_status la valeur « done » sera égale à la valeur « total ». | Dans le steps_status la valeur « done » sera égale à la valeur « total ». | ||
| - | + | \\ | |
| - | ---- | + | \\ |
| + | \\ | ||
| Dans le cadre de cette callback, vous devez renvoyer un code 2XX (par exemple 204) dans un délai inférieur à 10 secondes. | Dans le cadre de cette callback, vous devez renvoyer un code 2XX (par exemple 204) dans un délai inférieur à 10 secondes. | ||
| Si cette réponse n’est pas reçue, jusqu’à 6 nouvelles tentatives (retries) seront effectuées selon le planning suivant : | Si cette réponse n’est pas reçue, jusqu’à 6 nouvelles tentatives (retries) seront effectuées selon le planning suivant : | ||
| - | ^ Tentative ^ Secondes ^ Minutes ^ | + | ^ Tentative ^ Secondes ^ Minutes |
| - | | 1 | 10 | 0,17 | | + | | 1 | 10 | 0,17 | 0,17 | |
| - | | 2 | 80 | 1,33 | | + | | 2 | 80 | 1,33 | 1,50 | |
| - | | 3 | 270 | 4,50 | | + | | 3 | 270 | 4,50 | 6,00 | |
| - | | 4 | 640 | 10,67 | | + | | 4 | 640 | 10,67 | 16,67 | |
| - | | 5 | 1250 | 20,83 | | + | | 5 | 1250 | 20,83 | 37,50 | |
| - | | 6 | 2160 | 36,00 | | + | | 6 | 2160 | 36,00 | 73,50 | |
| - | | 7 | 3430 | 57,17 | | + | | 7 | 3430 | 57,17 |
| Ces intervalles sont calculés selon la formule : // | Ces intervalles sont calculés selon la formule : // | ||
| - | 10 x 6^n// (n correspondant au numéro de la tentative) — le résultat étant exprimé en secondes. | + | 10 x (n+1)^3// (n correspondant au numéro de la tentative) — le résultat étant exprimé en secondes. |
| ====== LES CALLBACKS ENDPOINTS ====== | ====== LES CALLBACKS ENDPOINTS ====== | ||
| Ligne 127: | Ligne 145: | ||
| " | " | ||
| { | { | ||
| - | | + | " |
| } | } | ||
| ] | ] | ||