Dit artikel is vertaald met behulp van AI en kan kleine onnauwkeurigheden bevatten. Raadpleeg de Engelse versie voor volledige nauwkeurigheid.
Dit artikel beschrijft de stappen om (alle) abonnementen voor je Bluedolphin-tenant op te halen.
HTTP response status code | Interpretatie |
200 OK | Abonnement succesvol opgehaald |
400 Bad Request | Abonnement kon niet worden opgehaald vanwege ongeldige tenantgegevens |
401 Unauthorized | Abonnement kon niet worden opgehaald omdat de gebruiker niet geautoriseerd is met de juiste API-sleutel |
404 Not Found | Kon geen abonnement vinden met het opgegeven ID |
500 Internal Server Error | De abonnementen konden niet worden opgehaald vanwege een serverfout |
Doe een GET-verzoek naar /subscriptions
Resource/endpoint bestemmings-URL
De header voor je API-verzoek
De {tenant} moet worden vervangen door de naam van de tenant
De volgende queryparameters zijn optioneel:
Include_disabled(inclusief op basis van de status van het abonnement)geldige opties:
trueoffalsebluedolphin_event (inclusief op basis van een specifiek event)
Ondersteunde events zijn
ObjectCreated, ObjectArchived, ObjectUpdated
Voorbeeld API-verzoek
curl --location --request GET 'https://public-api.eu.bluedolphin.app/nl/v1/subscriptions?include_disabled=true' \
--header 'x-api-key: YOURAPIKEYSECRET' \
--header 'tenant: tenantName' \
--header 'Content-Type: text/plain' \
Succesvolle respons:
Een geslaagde oproep geeft een respons met een 200 OK HTTP-statuscode en de volgende body:
{
"total_items": 1,
"items": [
{
"id": "Unieke identificatie",
"last_updated_by": "Unieke identificatie",
"url": "Unieke URL opgegeven",
"bluedolphin_event": "Eventnaam",
"headers": {},
"status": 0,
"http_verb": "POST",
"lifecycle_state": "All"
}
]
}
Respons-eigenschappen
Eigenschap | Type | Beschrijving |
id | string | Unieke identificatie voor het abonnement |
last_updated_by | string | Unieke identificatie van de persoon die het abonnement als laatste heeft bijgewerkt/aangemaakt |
url | string | De externe URL die is opgegeven waarnaar berichten worden gestuurd |
bluedolphin_event | string | De eventnaam waarvoor het abonnement is aangemaakt |
headers | object | De headers worden meegegeven indien nodig, om een verzoek te doen naar een externe URL met autorisatietokens |
http_verb | string | Het type verzoek dat naar de opgegeven URL wordt gestuurd |
lifecycle_state | enum | De Lifecycle-status waarop je kunt filteren. Waarden kunnen zijn:
|