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 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 von der Bearer-Authentifizierungsmethode gesendet wird.

Authorization: Bearer {api_key}

Beispiel

curl --request GET \
--url 'https://pushye.com/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 Zugriff auf die 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

All API endpoint results work with the UTC timezone unless specified otherwise.

Benutzer

Webseiten

Abonnenten

Abonnentenstatistiken

Abonnentenprotokolle

Kampagnen

Persönliche Benachrichtigungen

RSS automations

Recurring campaigns

Flüsse

Segmente

Benachrichtigungshandler

Benutzerdefinierte Domänen

Meine Teams

Teammitglieder

Teams-Mitglied

Kontozahlungen

Kontoprotokolle