API de Validation des Résultats | Silent Auth Français

Description

Le serveur de l'APP appelle cette interface pour envoyer les données chiffrées (payload) renvoyées par le SDK Engagelab au serveur Engagelab afin de vérifier la correspondance du numéro de téléphone.

Informations sur l'Interface

Élément	Description
Chemin de la requête	`POST /v1/verify`
Protocole	HTTPS
Authentification	HTTP Basic Auth
Content-Type	`application/json`

Domaine le plus récent : authapi.engagelab.com

Exemple de Requête

curl -X POST 'https://{authapi.engagelab.com}/v1/verify' \ -H 'Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl' \ -H 'Content-Type: application/json' \ -d '{ "payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..." }'

              
              curl -X POST 'https://{authapi.engagelab.com}/v1/verify' \
  -H 'Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl' \
  -H 'Content-Type: application/json' \
  -d '{
    "payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..."
  }'

Afficher ce bloc de code dans la fenêtre flottante

Authentification

Utilisez HTTP Basic Auth pour l'authentification :

Authorization: Basic base64(appKey:appSecret)

              
              Authorization: Basic base64(appKey:appSecret)

Afficher ce bloc de code dans la fenêtre flottante

Exemple :

appKey : tn4nm0qx032yx6f17q2tsa8f
appSecret : your_app_secret_here
encodage base64 : dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl

Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl

              
              Authorization: Basic dG40bm0wcXgwMzJ5eDZmMTdxMnRzYThmOnlvdXJfYXBwX3NlY3JldF9oZXJl

Afficher ce bloc de code dans la fenêtre flottante

Paramètres de la Requête

Paramètre	Type	Obligatoire	Description
payload	string	Oui	Les données chiffrées renvoyées par le SDK Engagelab, transmises par l'APP

Exemple de corps de requête :

{ "payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..." }

              
              {
  "payload": "uh/vX6WTi0vipwIBnUyt11h1OuDVImzWR/JuyySaztqmQLx1FKz6Xkpq83IhlEMi..."
}

Afficher ce bloc de code dans la fenêtre flottante

Paramètres de la Réponse

Réponse Réussie (HTTP 200)

Paramètre	Type	Description
code	int	Code de statut ; 0 signifie succès
msg	string	Description du statut
data	object	Données de la réponse
data.message_id	string	Identifiant unique du message, utilisable pour le dépannage
data.verified	boolean	Résultat de la vérification du numéro ; true signifie correspondant, false signifie non correspondant

Exemple de succès (vérification réussie) :

{ "code": 0, "msg": "success", "data": { "message_id": "1876123456789012345", "verified": true } }

              
              {
  "code": 0,
  "msg": "success",
  "data": {
    "message_id": "1876123456789012345",
    "verified": true
  }
}

Afficher ce bloc de code dans la fenêtre flottante

Exemple de succès (vérification échouée) :

{ "code": 0, "msg": "success", "data": { "message_id": "1876123456789012345", "verified": false } }

              
              {
  "code": 0,
  "msg": "success",
  "data": {
    "message_id": "1876123456789012345",
    "verified": false
  }
}

Afficher ce bloc de code dans la fenêtre flottante

Réponse d'Erreur (HTTP 4xx/5xx)

Paramètre	Type	Description
code	int	Code d'erreur
msg	string	Description de l'erreur

Exemple d'erreur :

{ "code": 2001, "msg": "auth failed" }

              
              {
  "code": 2001,
  "msg": "auth failed"
}

Afficher ce bloc de code dans la fenêtre flottante

Codes d'Erreur

Code d'erreur	Code de statut HTTP	Description	Solution recommandée
1000	500	Erreur interne du serveur	Veuillez réessayer plus tard ; si le problème persiste, contactez le support technique
2001	401	Échec de l'authentification	Vérifiez que appKey et appSecret sont corrects et que le format de Authorization est conforme à la spécification
2004	401	appKey invalide	Vérifiez que l'appKey est correct, ou contactez le support technique pour confirmer si le service est activé
3001	400	Format de paramètre invalide	Vérifiez que le corps de la requête est un JSON valide
3002	400	Échec de la validation des paramètres	Vérifiez que le paramètre payload existe et est au bon format
3003	400	appKey non concordant	L'appKey du payload ne correspond pas à l'appKey de l'en-tête d'authentification ; assurez-vous d'utiliser la bonne paire de clés
3004	400	Configuration non activée	La configuration du service n'est pas encore activée ; veuillez contacter le support technique pour l'activer
3005	400	Solde insuffisant	Le solde du compte est insuffisant ; veuillez recharger et réessayer
4001	400	Configuration introuvable	La configuration de service correspondante est introuvable ; veuillez contacter le support technique
5001	400	Échec de la vérification	Une exception s'est produite pendant le processus d'authentification de l'opérateur ; analysez selon les détails de msg ou contactez le support technique

Remarques

Transmission du payload : Après réception du payload renvoyé par le SDK Engagelab, l'APP doit le transmettre tel quel au serveur de l'APP, qui appelle ensuite cette interface. Ne modifiez le payload d'aucune manière.
Recommandation de sécurité : Conservez l'appSecret en lieu sûr et utilisez-le uniquement côté serveur ; ne l'exposez pas dans l'APP.
Résultat de la vérification : Une valeur verified égale à false signifie que le numéro de téléphone saisi par l'utilisateur ne correspond pas au numéro de la carte SIM, et la connexion de l'utilisateur doit être refusée.