Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://docs.acedata.cloud/llms.txt

Use this file to discover all available pages before exploring further.

L’API Artistic QR Tasks a pour principale fonction 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 Artistic QR Generation. Ce document détaillera les instructions d’intégration de l’API Artistic QR Tasks, vous aidant à l’intégrer facilement et à tirer pleinement parti de la puissance de cette API. Grâce à l’API Artistic QR Tasks, vous pouvez facilement interroger l’état d’exécution des tâches de l’API Artistic QR Generation.

​
Processus de demande

Pour utiliser l’API Artistic QR Tasks, vous devez d’abord vous rendre sur la page de demande Artistic QR Generation API pour demander le service correspondant, puis copier l’ID de tâche de l’API Artistic QR Generation, comme indiqué sur l’image :

Enfin, accédez à la page de l’API Artistic QR Tasks Artistic QR Tasks API pour demander le service correspondant. Une fois sur la page, cliquez sur le bouton « Acquire », comme indiqué sur l’image : 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 Artistic QR Tasks peut être utilisée pour interroger le résultat d’une API de l’API Artistic QR Generation. Pour savoir comment utiliser l’API Artistic QR Generation, veuillez consulter le document Artistic QR Generation API. Prenons un exemple avec un ID de tâche retourné par le service Artistic QR Generation. Supposons que nous ayons un ID de tâche : e2c65b20-a970-431e-99c1-76721e799df8, 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 demande et du corps de la demande

Request Headers comprend :
  • 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, que vous pouvez sélectionner directement après la demande.
Request Body comprend :
  • id : l’ID de tâche téléchargé.
  • action : la méthode d’opération sur la tâche.
Configurez comme indiqué sur l’image 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 indiqué sur l’image :

Voici quelques exemples de code :

​
CURL

curl -X POST 'https://api.acedata.cloud/qrart/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "id": "e2c65b20-a970-431e-99c1-76721e799df8",
  "action": "retrieve"
}'

​
Python

import requests

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

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

payload = {
    "id": "e2c65b20-a970-431e-99c1-76721e799df8",
    "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 code QR ici. Par exemple : 
{
  "_id": "668cb62c550a4144a582e372",
  "id": "e2c65b20-a970-431e-99c1-76721e799df8",
  "application_id": "3d25be99-4676-44d3-90bb-23086bc25300",
  "created_at": 1720497708.318,
  "credential_id": "6e80fca1-9a49-4507-ae8e-601dbd0ab3ca",
  "request": {
    "aspect_ratio": "1:1",
    "callback_url": null,
    "content": "https://platform.acedata.cloud",
    "content_image_url": null,
    "ecl": "H",
    "image_origin": null,
    "marker_shape": "square",
    "negative_prompt": null,
    "padding_level": 5,
    "padding_noise": 0,
    "pattern": "custom",
    "pixel_style": "square",
    "position": "center",
    "preset": "",
    "prompt": "mexican tacos",
    "qrw": 2,
    "ratio": null,
    "rotate": 0,
    "seed": null,
    "steps": 20,
    "sub_marker": "square",
    "timeout": null,
    "trace_id": "a99ecc24-eda0-45c6-bb5f-98060c30b490",
    "type": "link"
  },
  "response": {
    "image_url": "https://platform.cdn.acedata.cloud/qrart/e2c65b20-a970-431e-99c1-76721e799df8.png",
    "image_width": 768,
    "image_height": 768,
    "seed": 5324369603686616,
    "success": true
  }
}
Le résultat de la réponse contient plusieurs champs, le champ request est le corps de la demande 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, dont les résultats sont cohérents avec ceux de l’API Artistic QR Generation. Les champs sont décrits comme suit.
  • id, l’ID de la tâche de génération de ce code QR, utilisé pour identifier de manière unique cette tâche de génération de code QR.
  • request, les informations de demande dans la tâche de code QR.
  • response, les informations de réponse dans la tâche de code QR.

​
Opération de requête en lot

Ceci est destiné à interroger les détails de plusieurs ID de tâches de code QR, contrairement à ce qui précède, il est nécessaire de sélectionner l’action comme retrieve_batch. Request Body comprend :
  • ids : un tableau d’ID de tâches téléchargés.
  • action : la méthode d’opération sur la tâche.
Configurez comme indiqué sur l’image 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 indiqué sur l’image :

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 code QR en lot. Par exemple : 
{
  "items": [
    {
      "_id": "668cb90e550a4144a5834557",
      "id": "8c89e97b-6a79-4406-b2ce-e00f92540b4e",
      "application_id": "3d25be99-4676-44d3-90bb-23086bc25300",
      "created_at": 1720498446.039,
      "credential_id": "b7f9aaa1-43d8-471f-a826-cd0f4733fec5",
      "request": {
        "aspect_ratio": "1:1",
        "callback_url": null,
        "content": "https://huyinfu.space",
        "content_image_url": null,
        "ecl": "H",
        "image_origin": null,
        "marker_shape": "square",
        "negative_prompt": null,
        "padding_level": 5,
        "padding_noise": 0,
        "pattern": "custom",
        "pixel_style": "square",
        "position": "center",
        "preset": "",
        "prompt": "tacos mexicains",
        "qrw": 2,
        "ratio": null,
        "rotate": 0,
        "seed": null,
        "steps": 20,
        "sub_marker": "square",
        "timeout": null,
        "trace_id": "44d33486-0527-451f-afc2-df11aab7e049",
        "type": "link"
      },
      "response": {
        "image_url": "https://platform.cdn.acedata.cloud/qrart/8c89e97b-6a79-4406-b2ce-e00f92540b4e.png",
        "image_width": 768,
        "image_height": 768,
        "seed": 2701847236953402,
        "success": true
      }
    },
    {
      "_id": "668cb62c550a4144a582e372",
      "id": "e2c65b20-a970-431e-99c1-76721e799df8",
      "application_id": "3d25be99-4676-44d3-90bb-23086bc25300",
      "created_at": 1720497708.318,
      "credential_id": "6e80fca1-9a49-4507-ae8e-601dbd0ab3ca",
      "request": {
        "aspect_ratio": "1:1",
        "callback_url": null,
        "content": "https://platform.acedata.cloud",
        "content_image_url": null,
        "ecl": "H",
        "image_origin": null,
        "marker_shape": "square",
        "negative_prompt": null,
        "padding_level": 5,
        "padding_noise": 0,
        "pattern": "custom",
        "pixel_style": "square",
        "position": "center",
        "preset": "",
        "prompt": "tacos mexicains",
        "qrw": 2,
        "ratio": null,
        "rotate": 0,
        "seed": null,
        "steps": 20,
        "sub_marker": "square",
        "timeout": null,
        "trace_id": "a99ecc24-eda0-45c6-bb5f-98060c30b490",
        "type": "link"
      },
      "response": {
        "image_url": "https://platform.cdn.acedata.cloud/qrart/e2c65b20-a970-431e-99c1-76721e799df8.png",
        "image_width": 768,
        "image_height": 768,
        "seed": 5324369603686616,
        "success": true
      }
    }
  ],
  "count": 2
}

​
CURL

curl -X POST 'https://api.acedata.cloud/qrart/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "ids": ["8c89e97b-6a79-4406-b2ce-e00f92540b4e","e2c65b20-a970-431e-99c1-76721e799df8"],
  "action": "retrieve_batch"
}'

​
Python

import requests

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

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

payload = {
    "ids": ["8c89e97b-6a79-4406-b2ce-e00f92540b4e","e2c65b20-a970-431e-99c1-76721e799df8"],
    "action": "retrieve_batch"
}

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 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 Artistic QR Tasks pour interroger les détails de tâches de codes QR uniques 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.