Passer au contenu principal
La principale fonctionnalité de l’API Task de photo d’identité AI est de permettre la consultation de l’état d’exécution d’une tâche en entrant l’ID de tâche généré par l’API de création de photo d’identité AI. Ce document détaillera les instructions d’intégration de l’API Task de photo d’identité AI, vous aidant à intégrer facilement et à tirer pleinement parti des puissantes fonctionnalités de cette API. Grâce à l’API Task de photo d’identité AI, vous pouvez facilement interroger l’état d’exécution des tâches de l’API de création de photo d’identité AI.

​
Processus de demande

Pour utiliser l’API Task de photo d’identité AI, vous devez d’abord vous rendre sur la page de demande API de création de photo d’identité AI pour demander le service correspondant, puis copier l’ID de tâche de l’API de création de photo d’identité AI, comme illustré ci-dessous :

Enfin, accédez à la page de l’API Tasks API Task de photo d’identité AI pour demander le service correspondant. Une fois sur la page, cliquez sur le bouton « Acquire », comme illustré ci-dessous : Page de demande Si vous n’êtes pas encore connecté ou inscrit, vous serez automatiquement redirigé vers la page de connexion vous invitant à vous inscrire et à vous connecter. Après vous être connecté ou inscrit, vous serez automatiquement renvoyé à la page actuelle. Lors de votre première demande, un quota gratuit sera offert, vous permettant d’utiliser cette API gratuitement.

​
Exemple de demande

L’API Task de photo d’identité AI peut être utilisée pour interroger les résultats de l’API de création de photo d’identité AI. Pour savoir comment utiliser l’API de création de photo d’identité AI, veuillez consulter le document API de création de photo d’identité AI. Prenons un exemple avec un ID de tâche retourné par le service de création de photo d’identité AI. Supposons que nous ayons un ID de tâche : 16f96e95-d95c-46ef-b183-139b9bd1aebd, nous allons maintenant démontrer comment procéder en passant cet ID de tâche.

​
Exemple de tâche

​
Configuration des en-têtes de requête et du corps de requête

Request Headers inclut :
  • accept : spécifie que la réponse doit être au format JSON, ici rempli avec application/json.
  • authorization : la clé d’API pour appeler l’API, sélectionnable directement après la demande.
Request Body inclut :
  • id : l’ID de tâche téléchargé.
  • action : la méthode d’opération sur la tâche.
Configurer comme illustré ci-dessous :

​
Exemple de code

Vous pouvez constater que divers langages de code ont déjà été générés automatiquement sur le côté droit de la page, comme illustré ci-dessous :

Voici quelques exemples de code :

​
CURL

curl -X POST 'https://api.acedata.cloud/headshots/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "id": "16f96e95-d95c-46ef-b183-139b9bd1aebd",
  "action": "retrieve"
}'

​
Python

import requests

url = "https://api.acedata.cloud/headshots/tasks"

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

payload = {
    "id": "16f96e95-d95c-46ef-b183-139b9bd1aebd",
    "action": "retrieve"
}

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

​
Exemple de réponse

Après une demande réussie, l’API renverra les détails de la tâche de photo d’identité ici. Par exemple : 
{
  "_id": "67276ab6550a4144a53b6036",
  "id": "16f96e95-d95c-46ef-b183-139b9bd1aebd",
  "api_id": "53bcc3f7-12ec-4f04-8ca4-20f150dcde2a",
  "application_id": "1af53f80-c166-4f54-a8ea-0ffc24d8e2cd",
  "created_at": 1730636470.402,
  "credential_id": "3c253880-21ef-478a-9389-c09fa837ac7c",
  "request": {
    "mode": "relax",
    "template": "male_portrait",
    "image_urls": [
      "https://cdn.zhishuyun.com/2024-11-03-d23744954ca4819503469f04f2268aa0.jpg"
    ],
    "callback_url": "https://webhook.site/00f38b26-4289-4899-83d6-0cea7308850a"
  },
  "trace_id": "6eded0e2-274d-4cde-a567-d6b0decb9a97",
  "user_id": "ad7afe47-cea9-4cda-980f-2ad8810e51cf",
  "response": {
    "success": true,
    "task_id": "16f96e95-d95c-46ef-b183-139b9bd1aebd",
    "data": [
      {
        "id": "202411032022077381",
        "image_url": "https://platform.cdn.acedata.cloud/headshots/16f96e95-d95c-46ef-b183-139b9bd1aebd.png",
        "template": "男形象照"
      },
      {
        "id": "202411032022079194",
        "image_url": "https://platform.cdn.acedata.cloud/headshots/16f96e95-d95c-46ef-b183-139b9bd1aebd.png",
        "template": "男形象照"
      }
    ]
  }
}
Le résultat de la réponse contient plusieurs champs, le champ request est le corps de la requête lors de l’initiation de la tâche, tandis que le champ response est le corps de la réponse retourné après l’achèvement de la tâche. Les champs sont décrits comme suit.
  • id, l’ID de la tâche de photo d’identité générée, utilisé pour identifier de manière unique cette tâche de génération de photo d’identité.
  • request, les informations de requête dans la tâche de photo d’identité.
  • response, les informations de retour dans la tâche de photo d’identité.

​
Opération de requête en lot

Ceci est destiné à interroger les détails des tâches de photo d’identité pour plusieurs ID de tâche, contrairement à ce qui précède, l’action doit être sélectionnée comme retrieve_batch. Request Body inclut :
  • ids : tableau des ID de tâche téléchargés.
  • action : la méthode d’opération sur la tâche.
Configurer comme illustré ci-dessous :

​
Exemple de code

Vous pouvez constater que divers langages de code ont déjà été générés automatiquement sur le côté droit de la page, comme illustré ci-dessous :

Voici quelques exemples de code :

​
Exemple de réponse

Après une demande réussie, l’API renverra les détails spécifiques de toutes les tâches de photo d’identité en lot. Par exemple : 
{
  "items": [
    {
      "_id": "67276ab6550a4144a53b6036",
      "id": "16f96e95-d95c-46ef-b183-139b9bd1aebd",
      "api_id": "53bcc3f7-12ec-4f04-8ca4-20f150dcde2a",
      "application_id": "1af53f80-c166-4f54-a8ea-0ffc24d8e2cd",
      "created_at": 1730636470.402,
      "credential_id": "3c253880-21ef-478a-9389-c09fa837ac7c",
      "request": {
        "mode": "relax",
        "template": "male_portrait",
        "image_urls": [
          "https://cdn.zhishuyun.com/2024-11-03-d23744954ca4819503469f04f2268aa0.jpg"
        ],
        "callback_url": "https://webhook.site/00f38b26-4289-4899-83d6-0cea7308850a"
      },
      "trace_id": "6eded0e2-274d-4cde-a567-d6b0decb9a97",
      "user_id": "ad7afe47-cea9-4cda-980f-2ad8810e51cf",
      "response": {
        "success": true,
        "task_id": "16f96e95-d95c-46ef-b183-139b9bd1aebd",
        "data": [
          {
            "id": "202411032022077381",
            "image_url": "https://platform.cdn.acedata.cloud/headshots/16f96e95-d95c-46ef-b183-139b9bd1aebd.png",
            "template": "男形象照"
          },
          {
            "id": "202411032022079194",
            "image_url": "https://platform.cdn.acedata.cloud/headshots/16f96e95-d95c-46ef-b183-139b9bd1aebd.png",
            "template": "男形象照"
          }
        ]
      }
    },
    {
      "_id": "67276c52550a4144a53b995b",
      "id": "5213468b-6b96-4ad4-9c6a-657bd438d299",
      "api_id": "53bcc3f7-12ec-4f04-8ca4-20f150dcde2a",
      "application_id": "1af53f80-c166-4f54-a8ea-0ffc24d8e2cd",
      "created_at": 1730636882.359,
      "credential_id": "3c253880-21ef-478a-9389-c09fa837ac7c",
      "request": {
        "mode": "relax",
        "template": "male_portrait",
        "image_urls": [
          "https://cdn.zhishuyun.com/2024-11-03-d23744954ca4819503469f04f2268aa0.jpg"
        ],
        "callback_url": "https://webhook.site/00f38b26-4289-4899-83d6-0cea7308850a"
      },
      "trace_id": "50b2b4a8-6c1c-4b95-ac0b-46e5b97c7b18",
      "user_id": "ad7afe47-cea9-4cda-980f-2ad8810e51cf",
      "response": {
        "task_id": "5213468b-6b96-4ad4-9c6a-657bd438d299",
        "status": "unknown",
        "data": []
      }
    }
  ],
  "count": 2
}

​
CURL

curl -X POST 'https://api.acedata.cloud/headshots/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "ids": ["16f96e95-d95c-46ef-b183-139b9bd1aebd","5213468b-6b96-4ad4-9c6a-657bd438d299"],
  "action": "retrieve_batch"
}'

​
Python

import requests

url = "https://api.acedata.cloud/headshots/tasks"

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

payload = {
    "ids": ["16f96e95-d95c-46ef-b183-139b9bd1aebd","5213468b-6b96-4ad4-9c6a-657bd438d299"],
    "action": "retrieve_batch"
}

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

​
Erreur de traitement

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 requêtes, vous avez dépassé la limite de taux.
  • 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": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
Conclusion

Grâce à ce document, vous avez compris comment utiliser l’API Task de photo d’identité AI pour interroger les détails spécifiques d’une tâche de photo d’identité unique ou en lot. 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.