POUR LES CONSTRUCTEURS

Votre code.
Un nouveau flux de travail.

Découvrez l'intégration proposée et préparez votre application à l'API.

Contrat proposé. Les points de terminaison, les paramètres et les réponses doivent être confirmés auprès de l'équipe API avant une utilisation réelle.

Commencer

L'intégration comporte trois étapes : identifiez votre application, créez une tâche et suivez son résultat. Explorez l'expérience dans le tableau de bord de démonstration.

1Obtenir un identifiant auprès du service réel
2Créer une tâche avec son type et ses paramètres
3Récupérer le résultat grâce à son identifiant

Authentification

La proposition utilise un identifiant clientKey dans les appels au serveur. Conservez la clé dans les variables d'environnement, en dehors du code public et du navigateur. Les clés du tableau de bord de démonstration ne peuvent pas accéder aux services.

Créer une tâche

POST /createTask

Envoyez les informations d'identification et les paramètres requis pour le type sélectionné.

// Contrato proposto — configure a URL da API real no servidor
const response = await fetch(API_BASE_URL + "/createTask", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    clientKey: process.env.SOLUCAPTCHA_API_KEY,
    task: {
      type: "RecaptchaV2Task",
      websiteURL: "https://sua-aplicacao.com",
      websiteKey: "SUA_SITE_KEY"
    }
  })
});
if (!response.ok) throw new Error("Falha ao criar tarefa");
const task = await response.json();

Réponse attendue

{
  "errorId": 0,
  "taskId": "example-task-id"
}

Récupérer le résultat

POST /getTaskResult

Utilisez le taskId pour vérifier l'état. S'il est en cours de traitement, attendez avant de vérifier à nouveau, en respectant les intervalles et limites définis par l'API.

{
  "clientKey": "SUA_CHAVE_NO_SERVIDOR",
  "taskId": "example-task-id"
}

États et erreurs

ready

La tâche a un résultat disponible.

processing

La tâche est toujours en cours de traitement.

error

Vérifiez le code d'erreur renvoyé et la description.

Gérez les informations d'identification non valides, le solde insuffisant, les réponses inattendues et les délais d'attente. Les noms d'erreur finaux seront définis par l'API.

Besoin d'aide pour l'intégration ?