Developer portaal

Introductie

Spryng maakt onze API’s toegankelijk en het verzenden en ontvangen van berichten eenvoudig. Op deze pagina geven we je een korte introductie tot onze API’s. Meer informatie vind je in het developer portaal.

In de volgende video krijg je een overzicht van het developer portaal.

Wat is een API?

Een API (Application Programming Interface) verbindt jouw applicatie met andere diensten of gegevensbronnen. Bij een API-aanroep vraagt je gegevens aan, de API haalt deze op en stuurt je vervolgens een antwoord. Hiervoor gebruik je eenvoudig een HTTP-methode voor jouw aanvraag.

Stel je voor dat je eten bestelt in een restaurant. Je vertelt de ober jouw bestelling, hij geeft deze door aan de kok, en de ober brengt je vervolgens jouw eten. Een API-aanroep werkt op dezelfde manier.

API’s dienen twee hoofddoelen:

• Regeldefinitie: API’s leggen de interactie met de server uit. Ze stellen de regels voor developers vast.
• Gegevensoverdracht: Ze dragen gegevens efficiënt over tussen jouw applicatie en de server. Dit zorgt ervoor dat je de benodigde gegevens ontvangt.

API-eindpunt

Een API-eindpunt is een specifieke URL waarmee je toegang kunt krijgen tot een bron op de server. Het dient als communicatie-interface tussen een API-client en een API-server, waarover aanvragen binnenkomen en antwoorden worden uitgegeven.

Elk eindpunt bestaat uit:

• Een eindpunt-URL
  • Base URL -this remains fixed e.g. https://conversations.Spryng.co.uk
  • the endpoint path – this is where you can add configurable parameters which affect the response, acting as filters for your search
• Een HTTP-methode
• Headers
• Een Body

REST-API

Onze API’s maken gebruik van een REST-architectuur (Representational State Transfer), ook bekend als RESTful-API. Dit betekent dat ze online werken. Wanneer je een aanvraag naar een REST-API verzendt, ontvang je alle beschikbare gegevens.

Korte handleiding

Voordat je begint, moet je de volgende API-termen kennen:

Term	Definitie
API-keys	Een unieke toegangscode bestaande uit letters en cijfers, die toegang verleent tot een API.
Eindpunt	De digitale locatie/het pad waar een API aanvragen over haar bronnen ontvangt.
Aanvraagmethode	Gebruikt HTTP-methoden (GET, POST, PUT, DELETE) om de API te vertellen wat deze moet doen.
API-aanroep	Het proces waarbij een cliënt (jouw computer) een API-aanvraag naar een server verzendt.
Statuscode	Een numerieke code die in de antwoordtekst van een API verschijnt en aangeeft of jouw aanvraag succesvol was of niet.
API-server	Authenticeert en verwerkt API-aanvragen voordat deze een passend antwoord levert.
API-antwoord	Een door de API-server gegenereerd en naar de cliënt (jouw computer) teruggestuurd antwoord.

Als je meer wilt weten over API’s, bezoek dan ons developer portaal.