Passer au contenu principal
Cet article présente une documentation sur l’API d’informations d’identité et de vérification de la validité, qui peut être utilisée pour vérifier l’authenticité et la cohérence du nom, du numéro de carte d’identité et de la période de validité de la carte d’identité.

​
Processus de demande

Pour utiliser l’API, vous devez d’abord vous rendre sur la page correspondante de l’API d’informations d’identité et de vérification de la validité pour demander le service correspondant. Une fois sur la page, cliquez sur le bouton « Acquire », comme indiqué sur l’image : Si vous n’êtes pas encore connecté ou inscrit, vous serez automatiquement redirigé vers la page de connexion pour vous inviter à vous inscrire et à vous connecter. Après vous être connecté ou inscrit, vous serez automatiquement renvoyé à la page actuelle. Lors de la première demande, un quota gratuit sera offert, vous permettant d’utiliser cette API gratuitement.

​
Utilisation de base

Tout d’abord, comprenons la méthode d’utilisation de base, qui consiste à entrer le lien de l’image de la carte d’identité pour obtenir le résultat de vérification après traitement. Vous devez d’abord transmettre un champ name, puis vous pouvez remplir le contenu correspondant sur l’interface, comme indiqué sur l’image :

Nous pouvons voir ici que nous avons défini les en-têtes de requête, y compris :
  • accept : le format de réponse souhaité, ici rempli comme application/json, c’est-à-dire au format JSON.
  • authorization : la clé d’API pour appeler l’API, que vous pouvez sélectionner directement après la demande.
De plus, nous avons défini le corps de la requête, y compris :
  • name : nom.
  • id_card : numéro de carte d’identité.
  • image_url : lien de l’image faciale à traiter.
  • validity_end : date d’expiration de la carte d’identité, format : YYYYMMDD, pour une validité à long terme, utilisez « 00000000 ».
  • validity_begin : date de début de validité de la carte d’identité, format : YYYYMMDD.
  • encryption : optionnel, paramètre de cryptage pour les champs sensibles (si vous devez envoyer des données chiffrées).
Après avoir fait votre sélection, vous pouvez voir que le code correspondant a également été généré à droite, comme indiqué sur l’image :

Cliquez sur le bouton « Try » pour effectuer un test, comme indiqué sur l’image ci-dessus, et nous avons obtenu le résultat suivant : 
{
  "result": "0",
  "description": "Cohérent"
}
Le résultat de retour contient plusieurs champs, décrits comme suit :
  • result : code de résultat de l’authentification, les frais sont les suivants.
    • Codes de résultat payants :
      • 0 : le nom et le numéro de carte d’identité sont cohérents
      • -1 : le nom et le numéro de carte d’identité ne sont pas cohérents
    • Codes de résultat non payants :
      • -2 : numéro de carte d’identité illégal (longueur, chiffre de contrôle, etc. incorrects)
      • -3 : nom illégal (longueur, format, etc. incorrects)
      • -4 : anomalie du service de base de données des documents
      • -5 : aucun enregistrement de ce numéro de carte d’identité dans la base de données
      • -6 : système de comparaison autoritaire en cours de mise à jour, veuillez réessayer plus tard
      • -7 : le nombre d’authentifications a dépassé la limite quotidienne.
  • description : ici, le résultat de la vérification du nom et du numéro de carte d’identité.
On peut voir que le nom, le numéro de carte d’identité et la période de validité de la carte d’identité sont authentiques et cohérents. De plus, si vous souhaitez générer le code d’intégration correspondant, vous pouvez le copier directement, par exemple, le code CURL est le suivant : 
curl -X POST 'https://api.acedata.cloud/identity/idcard/check-2e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "name": "***",
  "id_card": "***",
  "validity_begin": "***",
  "validity_end": "***"
}'
Le code d’intégration Python est le suivant : 
import requests

url = "https://api.acedata.cloud/identity/idcard/check-2e"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "name": "***",
    "id_card": "***",
    "validity_begin": "***",
    "validity_end": "***"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

​
Gestion des erreurs

Lors de l’appel de l’API, si une erreur se produit, l’API renverra le code d’erreur et les informations correspondantes. Par exemple :
  • 400 token_mismatched : Mauvaise requête, probablement en raison de paramètres manquants ou invalides.
  • 400 api_not_implemented : Mauvaise requête, probablement en raison de paramètres manquants ou invalides.
  • 401 invalid_token : Non autorisé, jeton d’autorisation invalide ou manquant.
  • 429 too_many_requests : Trop de demandes, vous avez dépassé la limite de fréquence.
  • 500 api_error : Erreur interne du serveur, quelque chose s’est mal passé sur le serveur.

​
Exemple de réponse d’erreur

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "échec de la récupération"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
Conclusion

Grâce à ce document, vous avez compris comment utiliser l’API d’informations d’identité et de vérification de la validité pour vérifier l’authenticité et la cohérence du nom, du numéro de carte d’identité et de la période de validité de la carte d’identité. Nous espérons que ce document vous aidera à mieux intégrer et utiliser cette API. Si vous avez des questions, n’hésitez pas à contacter notre équipe de support technique.