API-dokumentaatio

Learn how to connect and integrate with our API.

Get your own API Key

Perus-URL-osoite

Todennus

All the API endpoints require an API key sent by the Bearer Authentication method.

Authorization: Bearer {api_key}

Esimerkki

curl --request GET \
--url 'https://popupke.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.

Esimerkki

{
    "errors": [
        {
            "title": "Sinulla ei ole p\u00e4\u00e4sy\u00e4 sovellusliittym\u00e4\u00e4n.",
            "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.

Käyttäjä

Tilastot

Kampanjat

Kampanjan ilmoitukset

Notification handlers

Omat joukkueet

Ryhmän jäsenet

Joukkueen jäsen

Tilin lokit