API-dokumentation

Detta är dokumentationen för de tillgängliga API-slutpunkterna, som är byggda kring REST-arkitekturen. Alla API-slutpunkter kommer att returnera ett JSON-svar med de standard HTTP-svarskoderna och kräver en Bearer-autentisering via en API-nyckel.

Get your own API Key

Bas-URL

Autentisering

Alla API-slutpunkter kräver en API-nyckel som skickas med Bearer Authentication-metoden.

Authorization: Bearer {api_key}

Exempel

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.

Exempel

{
    "errors": [
        {
            "title": "Du har inte tillg\u00e5ng till API:et.",
            "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.

Användare

Webbplatser

Prenumeranter

Prenumerantstatistik

Prenumerantloggar

Kampanjer

Personliga meddelanden

RSS automations

Recurring campaigns

Flöden

Segmenten

Notifikationshanterare

Anpassade domäner

Mina lag

Teammedlemmar

Teammedlem

Kontoinbetalningar

Kontologgar