API-Dokumentation

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

Eigenen API-Schlüssel erhalten

Basis-URL

Authentifizierung

Alle API-Endpunkte erfordern einen API-Schlüssel, der über die Bearer-Authentifizierung gesendet wird.

Authorization: Bearer {api_key}

Beispiel

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

Unsere API verwendet übliche HTTP-Statuscodes, um 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-Schlüssel fehlt oder ist ungültig

404 Die angeforderte Ressource wurde nicht gefunden

429 Zu viele Anfragen – Anfragelimit überschritten

500 Interner Serverfehler – das Problem liegt bei uns

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

Nutzer

Teams

Teammitglieder

Teammitglied

Kontoprotokoll