API-Dokumentation

Dies ist die Dokumentation für die verfügbaren API-Endpunkte, die auf der REST-Architektur basieren. Alle API-Endpunkte geben eine JSON-Antwort mit den standardmäßigen HTTP-Antwortcodes zurück und benötigen

Holen Sie sich Ihren eigenen API-Schlüssel

Basis-URL

Authentifizierung

Alle API-Endpunkte erfordern einen API-Schlüssel, der mit der Bearer-Authentifizierungsmethode gesendet wird.

Authorization: Bearer {api_key}

Beispiel

curl --request GET \
--url 'https://seo.gtechgroup.it/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Fehler

Unsere API verwendet herkömmliche HTTP-Statuscodes, um den Erfolg oder Misserfolg einer Anfrage anzuzeigen.

Beispiel

{
    "errors": [
        {
            "title": "Sie haben keinen Zugriff auf die API.",
            "status": 401
        }
    ]
}

Statuscodes

200 Anfrage erfolgreich abgeschlossen

400 Bad Request - Erforderliche Parameter fehlen oder sind ungültig

401 Unauthorized - API-Schlüssel fehlt oder ist ungültig

404 Die angeforderte Ressource wurde nicht gefunden

429 Too Many Requests - Ratenlimit überschritten

500 Internal Server Error - dies bedeutet, dass auf unserer Seite ein Problem vorliegt

Alle Ergebnisse der API-Endpunkte arbeiten mit der Zeitzone UTC, sofern nicht anders angegeben.

Benutzer

Websites

Prüfungen

Archivierte Prüfungen

Benachrichtigungs-Handler

Benutzerdefinierte Domains

Meine Teams

Teammitglieder

Teammitglied

Kontoprotokolle