FÜR BAUHERREN

Ihr Code.
Ein neuer Arbeitsablauf.

Entdecken Sie die vorgeschlagene Integration und bereiten Sie Ihre Anwendung für die API vor.

Vorgeschlagener Vertrag. Endpunkte, Parameter und Antworten müssen vor der tatsächlichen Verwendung mit dem API-Team bestätigt werden.

Erste Schritte

Die Integration besteht aus drei Schritten: Identifizieren Sie Ihre Anwendung, erstellen Sie eine Aufgabe und verfolgen Sie deren Ergebnis. Entdecken Sie das Erlebnis im Demo-Dashboard.

1Besorgen Sie sich einen Ausweis vom echten Dienst
2Erstellen Sie eine Aufgabe mit ihrem Typ und ihren Parametern
3Rufen Sie das Ergebnis mithilfe seiner Kennung ab

Authentifizierung

Der Vorschlag verwendet einen Berechtigungsnachweis clientKey bei Serveraufrufen. Behalten Sie den Schlüssel in Umgebungsvariablen außerhalb des öffentlichen Codes und des Browsers. Demo-Dashboard-Schlüssel können nicht auf Dienste zugreifen.

Erstellen Sie eine Aufgabe

POST /createTask

Senden Sie die Anmeldeinformationen und erforderlichen Parameter für den ausgewählten Typ.

// 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();

Erwartete Antwort

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

Rufen Sie das Ergebnis ab

POST /getTaskResult

Benutzen Sie die taskId um den Zustand zu überprüfen. Wenn die Verarbeitung ausgeführt wird, warten Sie mit der erneuten Überprüfung und beachten Sie dabei die von der API definierten Intervalle und Grenzwerte.

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

Zustände und Fehler

ready

Für die Aufgabe liegt ein Ergebnis vor.

processing

Die Aufgabe wird noch bearbeitet.

error

Überprüfen Sie den zurückgegebenen Fehlercode und die Beschreibung.

Behandeln Sie ungültige Anmeldeinformationen, unzureichendes Guthaben, unerwartete Antworten und Zeitüberschreitungen. Die endgültigen Fehlernamen werden von der API definiert.

Brauchen Sie Hilfe bei der Integration?