Admin-REST-API – Überblick
Was ist die Admin-REST-API?
Mit der Admin-REST-API können Sie Ihr MTCaptcha-Konto aus Ihrem eigenen Code verwalten, statt die Admin-Konsole zu verwenden. Sie richtet sich an Entwickler, die die Einrichtung von Sites automatisieren möchten, zum Beispiel beim Onboarding vieler Websites.
Damit können Sie:
- Sites: Ihre Sites auflisten sowie Namen und Einstellungen einer Site aktualisieren.
- Domains: Produktions- und Entwicklungsdomains einer Site anzeigen, hinzufügen und entfernen.
- IP-Whitelist: IP-Adressen auf der Whitelist einer Site anzeigen, hinzufügen und entfernen.
Die API funktioniert nur mit Ihrem eigenen Konto. Die Limits Ihres Tarifs gelten genau wie in der Admin-Konsole.
Die Admin-REST-API unterscheidet sich von der CheckToken-API, mit der ein verifiziertes Token validiert wird. Die Admin-REST-API verwaltet Ihr Konto. Die CheckToken-API überprüft ein Captcha-Ergebnis auf Ihrem Server.
Vor dem Start
- Zugriff anfragen. Die Admin-REST-API ist standardmäßig nicht aktiviert. Wenden Sie sich an support@mtcaptcha.com, um sie für Ihr Konto zu aktivieren.
- API-Schlüssel erstellen. Sobald die API aktiviert ist, kann der Super Admin Ihres Kontos in der Admin-Konsole im linken Menü Admin API öffnen und dort den Schlüssel erstellen.
Behandeln Sie den API-Schlüssel wie ein Passwort. Verwenden Sie ihn nur auf Ihrem Server, niemals in Browser-Code, mobilen Apps oder öffentlichen Repositories. Falls er offengelegt worden sein könnte, erstellen Sie ihn auf der Seite Admin API neu. Der alte Schlüssel und alle damit ausgestellten Tokens werden sofort ungültig.
Was Sie tun können
Eine Übersicht der verfügbaren Aufrufe. Alle Pfade beginnen mit /v1.
Sites
| Methode | Pfad | Beschreibung |
|---|---|---|
GET | /sites | Ihre Sites auflisten. Optionale Filter: from, to, sortField, sortOrder. |
PATCH | /sites/{sitePublicId} | Namen und Einstellungen einer Site aktualisieren. |
Domains
| Methode | Pfad | Beschreibung |
|---|---|---|
GET | /sites/{sitePublicId}/domains | Alle Domains auflisten. Mit /prod oder /dev am Ende filtern. |
POST | /sites/{sitePublicId}/domains/{type} | Eine Domain hinzufügen. type ist prod oder dev. |
DELETE | /sites/{sitePublicId}/domains/{type}/{domainName} | Eine Domain entfernen. |
IP-Whitelist
| Methode | Pfad | Beschreibung |
|---|---|---|
GET | /sites/{sitePublicId}/ip-whitelist | IP-Adressen auf der Whitelist auflisten. |
POST | /sites/{sitePublicId}/ip-whitelist | Eine IP-Adresse hinzufügen. |
DELETE | /sites/{sitePublicId}/ip-whitelist?ipAddress=... | Eine IP-Adresse entfernen. |
Erste Schritte
Die Authentifizierung besteht aus zwei Schritten. Sie tauschen Ihren API-Schlüssel gegen ein kurzlebiges Zugriffstoken und senden dieses Token mit jeder Anfrage. Ersetzen Sie YOUR_API_KEY und YOUR_TOKEN durch Ihre eigenen Werte und führen Sie die Befehle auf Ihrem Server oder im Terminal aus, niemals auf einer Webseite.
Schritt 1: Zugriffstoken abrufen
curl -X POST "https://admin-api.mtcaptcha.com/auth/token" \
-H "X-Api-Key: YOUR_API_KEY"
Sie erhalten das Token zurück. Verwenden Sie es im nächsten Schritt:
{ "status": "success", "token": "..." }
Schritt 2: Ihre Sites auflisten
curl "https://admin-api.mtcaptcha.com/v1/sites" \
-H "Authorization: Bearer YOUR_TOKEN"
Schritt 3: Weitermachen und bei Bedarf erneuern
Senden Sie in jeder Anfrage denselben Header Authorization: Bearer YOUR_TOKEN. Tokens sind kurzlebig: Wenn Sie die Antwort 401 erhalten, wiederholen Sie Schritt 1, um ein neues Token zu erhalten. Fordern Sie nicht für jeden Aufruf ein neues Token an.
Fehler werden als JSON mit status und einer message zurückgegeben, die erklärt, was zu korrigieren ist.
API-Referenz
Die vollständige Liste der Endpunkte, die Anfrage- und Antwortformate sowie die Möglichkeit, jeden Aufruf auszuprobieren, finden Sie in der Swagger-Referenz:
Admin-REST-API-Referenz öffnen (Swagger)
Nicht gefunden, was Sie brauchten? Wenden Sie sich gerne an unser Support-Team unter support@mtcaptcha.com oder hinterlassen Sie uns eine Nachricht auf unserer Kontakt-Seite.