API-Dokumentation

Erfahre, wie du dich mit unserer API verbindest und integrierst.

Basis-URL

Authentifizierung

Alle API-Endpunkte benötigen einen API-Schlüssel, der über die Bearer-Authentication-Methode gesendet wird.

Authorization: Bearer {api_key}

Beispiel

curl --request GET \
--url 'https://app.smartseoaudit.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Unsere API verwendet konventionelle HTTP-Status-Codes, um Erfolg oder Fehler einer Anfrage anzuzeigen.

Beispiel

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

Status-Codes

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 Zu viele Anfragen — Rate-Limit überschritten

500 Interner Server-Fehler — bei uns ist etwas schiefgelaufen

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

Benutzer

Websites

Audits

Archivierte Audits

Benachrichtigungs-Handler

Teams

Teammitglieder

Teams-Mitglied

Konto-Zahlungen

Konto-Protokolle