API-documentatie

Leer hoe je verbinding maakt met onze API en ermee integreert.

Je eigen API-sleutel ophalen

Basis-URL

Authenticatie

Voor alle API-endpoints is een API-sleutel nodig die wordt verstuurd via de Bearer-authenticatiemethode.

Authorization: Bearer {api_key}

Voorbeeld

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

Onze API gebruikt gangbare HTTP-statuscodes om aan te geven of een verzoek is geslaagd of mislukt.

Voorbeeld

{
    "errors": [
        {
            "title": "Je hebt geen toegang tot de API.",
            "status": 401
        }
    ]
}

Statuscodes

200 Verzoek succesvol voltooid

400 Ongeldig verzoek - Verplichte parameters ontbreken of zijn ongeldig

401 Niet geautoriseerd - API-sleutel ontbreekt of is ongeldig

404 De gevraagde bron is niet gevonden

429 Te veel verzoeken - Limiet overschreden

500 Interne serverfout - dit betekent dat er een probleem aan onze kant is

Alle resultaten van API-endpoints gebruiken de tijdzone UTC, tenzij anders is aangegeven.

Gebruiker

Statistieken

Campagnes

Campagnemeldingen

Meldingskanalen

Accountbetalingen

Aanmeldingen via verwijzing

Accountlogboeken