Passer au contenu principal
Cet article présente une documentation sur l’intégration de l’API de création de photos d’identité AI, qui permet de créer divers styles de photos d’identité en entrant l’URL d’une photo de portrait et un modèle de votre choix.

Processus de demande

Pour utiliser l’API, vous devez d’abord vous rendre sur la page correspondante de l’API de création de photos d’identité AI 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 l’API gratuitement.

Utilisation de base

Tout d’abord, comprenez la méthode d’utilisation de base, qui consiste à entrer l’image de portrait à traiter ainsi que le modèle de photo d’identité AI que vous aimez, pour obtenir le résultat traité. Vous devez d’abord transmettre un champ image_urls, qui est un tableau de liens vers les images de portrait à traiter, comme indiqué sur l’image :

Ensuite, nous devons également entrer le modèle que nous préférons. Cet article propose huit modèles populaires, les modèles spécifiques peuvent être consultés ci-dessous :
{
   "male_portrait":  Photo de portrait masculin,
   "male_portrait2":  Photo de portrait masculin (autre version),
   "kindergarten":  Photo d'entrée à la maternelle,
   "logo_tshirt": Photo de T-shirt avec logo d'entreprise,
   "wedding":  Photo d'enregistrement de mariage,
   "business_photo":  Photo professionnelle,
   "bob_suit": Costume noir avec coupe bob,
   "female_portrait":  Photo de portrait féminin
}
Ensuite, nous pouvons également spécifier le paramètre de vitesse de génération mode, qui se divise généralement en deux types : lent relax et rapide fast, les détails sont les suivants :

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 avec 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 :
  • mode : le canal de génération de la photo d’identité, principalement divisé en deux types : fast rapide et relax lent. Lors de l’utilisation de relax, il est fortement recommandé d’utiliser le paramètre callback_url ci-dessous.
  • template : le style du modèle de photo d’identité.
  • image_urls : les liens des images de portrait à télécharger.
  • callback_url : l’URL pour recevoir les résultats.
Après avoir fait votre choix, vous pouvez constater 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 :
{
  "success": true,
  "task_id": "ae1e4948-dba1-4a6f-87af-67961b647428",
  "data": [
    {
      "id": "202411031951124776",
      "image_url": "https://platform.cdn.acedata.cloud/headshots/ae1e4948-dba1-4a6f-87af-67961b647428.png",
      "template": "Photo de portrait masculin"
    },
    {
      "id": "202411031951128490",
      "image_url": "https://platform.cdn.acedata.cloud/headshots/ae1e4948-dba1-4a6f-87af-67961b647428.png",
      "template": "Photo de portrait masculin"
    }
  ]
}
Le résultat de retour contient plusieurs champs, décrits comme suit :
  • success : l’état de la tâche de génération de la photo d’identité.
  • task_id : l’ID de la tâche de génération de la photo d’identité.
  • data : la liste des résultats de la tâche de génération de la photo d’identité.
    • id : l’ID de la photo de la tâche de génération de la photo d’identité.
    • image_url : le lien de l’image de la tâche de génération de la photo d’identité.
    • template : le nom du modèle de photo d’identité de la tâche de génération.
Nous pouvons voir que nous avons obtenu des informations satisfaisantes sur la photo d’identité en fonction du modèle et de l’image de portrait. Nous n’avons qu’à récupérer la photo d’identité à partir de l’adresse du lien d’image dans data. 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/headshots/generate' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "mode": "fast",
  "template": "male_portrait",
  "image_urls": ["https://cdn.zhishuyun.com/2024-11-03-d23744954ca4819503469f04f2268aa0.jpg"]
}'

Rappel asynchrone

Étant donné que le temps de génération des photos d’identité AI est relativement long, environ 1 à 2 minutes, si l’API ne répond pas pendant longtemps, la requête HTTP maintiendra la connexion, entraînant une consommation supplémentaire de ressources système. Par conséquent, cette API propose également un support de rappel asynchrone. Le processus global est le suivant : lorsque le client effectue une demande, il spécifie également un champ callback_url. Après que le client ait lancé la demande API, l’API renverra immédiatement un résultat contenant un champ d’information task_id, représentant l’ID de la tâche actuelle. Lorsque la tâche est terminée, le résultat de la génération de la photo d’identité sera envoyé au callback_url spécifié par le client sous forme de POST JSON, incluant également le champ task_id, permettant ainsi de lier le résultat de la tâche par ID. Voyons maintenant un exemple pour comprendre comment procéder. Tout d’abord, le rappel Webhook est un service capable de recevoir des requêtes HTTP. Les développeurs doivent le remplacer par l’URL de leur propre serveur HTTP. Pour des raisons de démonstration, nous utiliserons un site d’exemple Webhook public https://webhook.site/, en ouvrant ce site, vous obtiendrez une URL Webhook, comme indiqué sur l’image : Copiez cette URL, qui peut être utilisée comme Webhook. L’exemple ici est https://webhook.site/00f38b26-4289-4899-83d6-0cea7308850a. Ensuite, nous pouvons définir le champ callback_url sur l’URL Webhook ci-dessus, tout en remplissant le lien de l’image de portrait et le modèle. Cet article recommande d’utiliser le rappel asynchrone lorsque le paramètre mode est relax, les détails sont indiqués sur l’image :

Cliquez sur Exécuter, et vous constaterez que vous obtiendrez immédiatement un résultat, comme suit :
{
  "task_id": "763b1450-8804-434f-acc7-d713be73a28f"
}
Après un court instant, vous pourrez observer le résultat de la génération de la chanson sur https://webhook.site/00f38b26-4289-4899-83d6-0cea7308850a, comme indiqué sur l’image : Le contenu est le suivant :
{
    "success": true,
    "task_id": "763b1450-8804-434f-acc7-d713be73a28f",
    "data": [
        {
            "id": "202411032010131366",
            "image_url": "https://platform.cdn.acedata.cloud/headshots/763b1450-8804-434f-acc7-d713be73a28f.png",
            "template": "photo d'identité masculine"
        },
        {
            "id": "202411032010132420",
            "image_url": "https://platform.cdn.acedata.cloud/headshots/763b1450-8804-434f-acc7-d713be73a28f.png",
            "template": "photo d'identité masculine"
        }
    ]
}
On peut voir que le résultat contient un champ task_id, les autres champs étant similaires à ceux mentionnés ci-dessus, ce champ permettant d’associer les tâches.

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 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": "é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 de création de photos d’identité AI, qui permet de créer divers styles de photos d’identité en entrant l’URL d’une photo de portrait et le modèle de votre choix. 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.