Erste Schritte

Endpoints

Diese Seite wurde maschinell aus der chinesischen Version übersetzt und kann Fehler enthalten. Maßgeblich ist die chinesische Version.

Die YesCaptcha API hat zwei Endpoints mit identischen Methoden und Parametern. Wählen Sie den Endpoint, der zum Standort Ihrer Server passt:

Endpoint	Adresse	Geeignet für
Globaler Endpoint	`https://api.yescaptcha.com`	Server außerhalb des chinesischen Festlands
China-Endpoint	`https://cn.yescaptcha.com`	Server auf dem chinesischen Festland

Die URL einer Methode besteht aus der Endpoint-Adresse und dem Methodennamen, zum Beispiel beim Erstellen einer Aufgabe:

POSThttps://api.yescaptcha.com/createTaskGlobaler Endpoint

POSThttps://cn.yescaptcha.com/createTaskChina-Endpoint

Regeln

Verwenden Sie nur HTTPS.
Alle Methoden außer /useragent verwenden POST mit einem JSON-Body und dem Header Content-Type: application/json. Der Body darf höchstens 6 MB groß sein.
Die Authentifizierung erfolgt über den clientKey im Body; weitere Header sind nicht nötig.

Methode	Zweck	Hinweise
createTask	Aufgabe erstellen	Synchrone Typen geben das Ergebnis direkt zurück
getTaskResult	Aufgabenergebnis abfragen	Bei asynchronen Typen alle 5 Sekunden abfragen
getBalance	Guthaben abfragen	Kein Punkteabzug
getSoftID	Entwickler-ID abfragen	Für die Entwicklerbeteiligung
report	Ergebnisse melden	Bei Typen der Bilderkennung kann eine Erstattung nach Meldung beantragt werden
useragent	Empfohlenen User-Agent abrufen	`GET`, für hCaptcha

Wenn Sie keine Verbindung herstellen können, lesen Sie Verbindungs- und Netzwerkprobleme.