Hoppa till huvudinnehåll
AI ID-foto Task API:s huvudsakliga funktion är att genom att ange det uppdrag ID som genererats av AI ID-foto skapande API, kunna kontrollera statusen för det uppdraget. Detta dokument kommer att detaljerat beskriva integrationen av AI ID-foto Task API, för att hjälpa dig att enkelt integrera och fullt utnyttja den kraftfulla funktionen av detta API. Genom AI ID-foto Task API kan du enkelt kontrollera statusen för uppdraget från AI ID-foto skapande API.

​
Ansökningsprocess

För att använda AI ID-foto Task API, behöver du först gå till ansökningssidan AI ID-foto skapande API för att ansöka om den aktuella tjänsten, och sedan kopiera uppdrag ID från AI ID-foto skapande API, som visas i bilden:

Slutligen går du till Tasks API-sidan AI ID-foto Task API för att ansöka om den aktuella tjänsten, när du kommer in på sidan, klicka på knappen “Acquire”, som visas i bilden: Ansökningssidan Om du inte har loggat in eller registrerat dig, kommer du automatiskt att omdirigeras till inloggningssidan för att registrera dig och logga in, efter inloggning och registrering kommer du automatiskt att återvända till den aktuella sidan. Vid första ansökan kommer det att finnas en gratis kvot som ges, så att du kan använda detta API gratis.

​
Begärningsexempel

AI ID-foto Task API kan användas för att kontrollera resultaten från AI ID-foto skapande API. För information om hur man använder AI ID-foto skapande API, vänligen se dokumentet AI ID-foto skapande API. Vi tar ett exempel med ett uppdrag ID som returnerats av AI ID-foto skapande API, för att demonstrera hur man använder detta API. Anta att vi har ett uppdrag ID: 16f96e95-d95c-46ef-b183-139b9bd1aebd, och vi visar hur man gör detta genom att skicka in ett uppdrag ID.

​
Uppdragsexempelbild

​
Ställ in begärningshuvuden och begärningskropp

Begärningshuvuden inkluderar:
  • accept: specificera att du tar emot svar i JSON-format, här anges som application/json.
  • authorization: nyckeln för att anropa API:t, som kan väljas direkt efter ansökan.
Begärningskropp inkluderar:
  • id: det uppladdade uppdrag ID.
  • action: hur uppdraget ska hanteras.
Inställningarna visas i bilden nedan:

​
Kodexempel

Det kan noteras att olika språkets kod redan har genererats automatiskt på högra sidan, som visas i bilden:

Några kodexempel visas nedan:

​
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)

​
Svarsexempel

Vid en lyckad begäran kommer API:t att returnera detaljerad information om detta ID-foto uppdrag. Till exempel: 
{
  "_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": "manligt porträtt"
      },
      {
        "id": "202411032022079194",
        "image_url": "https://platform.cdn.acedata.cloud/headshots/16f96e95-d95c-46ef-b183-139b9bd1aebd.png",
        "template": "manligt porträtt"
      }
    ]
  }
}
Det returnerade resultatet innehåller flera fält, där request-fältet är begärningskroppen vid uppdraget, medan response-fältet är svaret som returneras efter att uppdraget har slutförts. Fälten beskrivs nedan.
  • id, ID:t för att generera detta ID-foto uppdrag, används för att unikt identifiera detta ID-foto skapande uppdrag.
  • request, begärningsinformationen i ID-foto uppdraget.
  • response, svarsinformationen i ID-foto uppdraget.

​
Batchfrågeoperation

Detta är för att fråga detaljerna för ID-foto uppdrag för flera uppdrag ID, till skillnad från ovanstående, behöver action väljas som retrieve_batch. Begärningskropp inkluderar:
  • ids: en array av uppladdade uppdrag ID.
  • action: hur uppdraget ska hanteras.
Inställningarna visas i bilden nedan:

​
Kodexempel

Det kan noteras att olika språkets kod redan har genererats automatiskt på högra sidan, som visas i bilden:

Några kodexempel visas nedan:

​
Svarsexempel

Vid en lyckad begäran kommer API:t att returnera detaljerad information om alla batch ID-foto uppdrag. Till exempel: 
{
  "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": "manligt_porträtt",
        "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": "manligt_porträtt",
        "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": "okänd",
        "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": "hämta_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": "hämta_batch"
}

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

​
Felhantering

Vid anrop av API:et, om ett fel uppstår, kommer API:et att returnera motsvarande felkod och information. Till exempel:
  • 400 token_mismatched：Felaktig begäran, möjligtvis på grund av saknade eller ogiltiga parametrar.
  • 400 api_not_implemented：Felaktig begäran, möjligtvis på grund av saknade eller ogiltiga parametrar.
  • 401 invalid_token：Obehörig, ogiltig eller saknad auktoriseringstoken.
  • 429 too_many_requests：För många begärningar, du har överskridit hastighetsgränsen.
  • 500 api_error：Intern serverfel, något gick fel på servern.

​
Felrespons Exempel

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "hämtning misslyckades"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
Slutsats

Genom detta dokument har du fått en förståelse för hur man använder AI ID-foto Task API för att hämta alla specifika detaljer om enskilda eller batch ID-foto uppgifter. Vi hoppas att detta dokument kan hjälpa dig att bättre integrera och använda API:et. Om du har några frågor, tveka inte att kontakta vårt tekniska supportteam.