Sitekey und Secret prüfen

Warning

Rufen Sie den Endpunkt ausschließlich von Ihrem Server auf. Das Secret bleibt auf dem Server und gehört nicht in den Quelltext der Seite.

Senden Sie eine POST-Anfrage an den Endpunkt /verify-credentials unter https://api.eu-captcha.eu/v1.

Beschreibung

Der Endpunkt prüft, ob ein Paar aus Sitekey und Secret gültig und aktiv ist. Ein Token des Besuchers ist dafür nicht erforderlich. Setzen Sie den Aufruf beim Start Ihrer Anwendung oder beim Einrichten ein, um fehlerhafte Zugangsdaten früh zu erkennen.

Im Unterschied zu /verify verbraucht der Endpunkt kein Token und führt keine Proof-of-Work-Prüfung aus. Er stellt ausschließlich fest, ob die übergebenen Zugangsdaten bekannt und freigeschaltet sind.

Der Endpunkt steht ab Version 1.1 der API zur Verfügung.

Siehe Client-Token prüfen.

Anfrage

Der Rumpf der Anfrage enthält die folgenden Felder:

Feld	Typ	Erforderlich	Beschreibung
sitekey	string	ja	Öffentlicher Sitekey der Domain, in der das Widget eingebunden ist. Der Wert steht in der Ansicht Details des Sitekeys.
secret	string	ja	Zum Sitekey gehörendes Secret. Der Wert steht in der Ansicht Details des Sitekeys und bleibt auf dem Server.

Siehe Ansicht Details.

Beispiel

Rumpf der Anfrage:

{
  "sitekey": "1c87e240-0000-0000-0000-23ac9f99da68",
  "secret": "LqFgQA••••"
}

Antworten

Der Endpunkt liefert die folgenden Statuscodes:

Statuscode	Beschreibung
200	Ergebnis der Prüfung der Zugangsdaten.
400	Im Rumpf der Anfrage fehlen erforderliche Felder, oder der Rumpf ist fehlerhaft.
429	Die Anzahl der Anfragen ist überschritten. Warten Sie die in der Kopfzeile Retry-After genannte Anzahl Sekunden ab und wiederholen Sie die Anfrage.
500	Unerwarteter Fehler auf dem Server.

Antwortfelder

Die Antwort mit dem Statuscode 200 enthält das folgende Feld:

Feld	Typ	Beschreibung
valid	boolean	true, falls der Sitekey vorhanden ist und das Secret dazu passt, sonst false.

Beispiele der Antwort

Zugangsdaten gültig:

{
  "valid": true
}

Sitekey unbekannt oder Secret nicht passend:

{
  "valid": false
}

Fehlerantwort mit den Statuscodes 400, 429 und 500:

{
  "error": "missing_field",
  "message": "Required field 'sitekey' is missing."
}