API-Dokumentation

Erfahre, wie du unsere API verbindest und integrierst.

Eigenen API-Key abrufen

Basis-URL

Authentifizierung

Alle API-Anfragen erfordern eine Authentifizierung über einen API-Key, der wie unten gezeigt im Authorization-Header gesendet wird.

Authorization: Bearer {api_key}

Beispiel

curl --request GET \
--url 'https://okk.link/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Unsere API verwendet übliche HTTP-Statuscodes, um den Erfolg oder Fehlschlag einer Anfrage anzuzeigen.

Beispiel

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

Statuscodes

200 Anfrage erfolgreich abgeschlossen

400 Ungültige Anfrage - erforderliche Parameter fehlen oder sind ungültig

401 Nicht autorisiert - API-Key fehlt oder ist ungültig

404 Die angeforderte Ressource wurde nicht gefunden

429 Zu viele Anfragen - Rate-Limit überschritten

500 Interner Serverfehler - es liegt ein Problem auf unserer Seite vor

Alle Ergebnisse der API-Endpunkte verwenden die Zeitzone UTC, sofern nicht anders angegeben.

Benutzer

Links

Link-Statistiken

Pixel

Splash-Pages

QR-Codes

Signaturen

Daten

Benachrichtigungs-Handler

Eigene Domains

Teams

Team-Mitglieder

Team-Mitglied

Zahlungen

Referred signups

Konto-Protokolle