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 een abonnement op te halen in BlueDolphin.
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/{id}:
Resource/endpoint bestemmings-URL
De header voor je API-verzoek
Vervang {tenant} door de naam van de tenant
Vervang het ID door het ID van het op te halen abonnement
Optionele queryparameters:
include_disabled
bluedolphin_event
De volgende events worden momenteel ondersteund:
ObjectCreated,
ObjectArchived,
ObjectUpdated
Voorbeeld API-verzoek
curl --location --globoff --request GET 'https://public-api.eu.bluedolphin.app/nl/v1/subscriptions/‘{id} \
--header 'x-api-key: YOURAPIKEYSECRET' \
--header 'tenant: tenantName' \
Succesvolle response
Een geslaagde oproep geeft een response met een 200 OK HTTP-statuscode en de volgende body:
{
"id": "Unieke identificatie",
"last_updated_by": "Unieke identificatie",
"url": "Unieke URL opgegeven",
"bluedolphin_event": "Event Naam",
"lifecycle_state": "Huidig"
"headers": {},
"status": 0,
"http_verb": "POST"
}
Response-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 moet worden gedaan naar de opgegeven URL |
lifecycle_state | Enum | De lifecycle status waarop gefilterd kan worden. Waarden kunnen zijn:
|