API-Dokumentation

Dies ist die Dokumentation für die verfügbaren API-Endpunkte, die um die REST-Architektur herum aufgebaut sind. Alle API-Endpunkte liefern eine JSON-Antwort mit den standardmäßigen HTTP-Antwortcodes und benötigen eine Bearer-Authentifizierung über einen API-Schlüssel.

Get your own API Key

Basis-URL

Authentifizierung

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

Authorization: Bearer {api_key}

Beispiel

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

Errors

Our API uses conventional HTTP status codes to indicate the success or failure of a request.

Beispiel

{
    "errors": [
        {
            "title": "Sie haben keinen Zugang zur API.",
            "status": 401
        }
    ]
}

Status codes

200 Request completed successfully

400 Bad request - Required parameters are missing or invalid

401 Unauthorized - API key is missing or invalid

404 The requested resource was not found

429 Too many requests - Rate limit exceeded

500 Internal server error - this means there is a problem on our end

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

Benutzer

Webseiten

Abonnenten

Abonnenten Statistik

Abonnentenprotokolle

Kampagnen

Persönliche Benachrichtigungen

RSS-Automatisierungen

Wiederkehrende Kampagnen

Flows

Segmente

Benachrichtigungshandler

Benutzerdefinierte Domains

Kontozahlungen

Kontenprotokolle