Over de REST API van Paazl

Dit artikel biedt een vogelvlucht op hoe de REST API-koppeling van Paazl werkt en de stappen op hoofdlijnen die nodig zijn om deze te integreren.

Er zijn twee manieren om de checkout-functionaliteit van Paazl in jouw webshop te integreren. De snelste manier is om de Paazl Checkout-widget te integreren. Richt je server in, voeg een paar regels code toe aan jouw website en je bent direct up and running.

Als je jouw eigen gebruikersinterface voor bezorgopties wilt gebruiken, kun je de integratie van Paazls checkout-functionaliteit op maat inrichten door de REST API-methoden van Paazl rechtstreeks aan te roepen, zoals beschreven in dit artikel.

Hoe de REST API werkt

Authenticatie

Paazl maximaliseert de beveiliging van het bestelproces van jouw webshop door gebruik te maken van three-legged OAuth 2.0-authenticatie, waarbij de "API-secret" (privésleutel) alleen bekend is bij jouw webshop. Jouw klanten hebben alleen toegang tot de "API-key" (openbare sleutel).

Zie Authenticatie & Autorisatie voor een uitleg over hoe Paazls three-legged OAuth 2.0-authenticatie werkt en hoe je API-sleutels genereert.

De Paazl autorisatiestring

De autorisatiestring die je opneemt in de header van de methode-aanroep kan van een van de volgende twee typen zijn:

• Aanroepen die alleen de API-key vereisen
• Aanroepen die zowel de API-key als de API-secret vereisen

Aanroepen die de API-key vereisen

• POST checkout
• POST shippingoptions
• POST pickuplocations

Voorbeeld: Authorization: Bearer sI3flYhflh

Aanroepen die de API-key en API-secret vereisen

• POST token
• GET checkout
• POST order
• PUT order
• DELETE order

Voorbeeld: Authorization: Bearer sI3flYhflh:sdHlHkyunLKsoI94luilIlndD

Vereisten

Er zijn geen andere vereisten dan de mogelijkheid van jouw webshop om REST API-webserviceverzoeken te verzenden en de resulterende antwoorden te ontvangen.

Mogelijk wil je de IP-adressen van de authenticatie- en API-servers van Paazl op de whitelist zetten. De URL van de betreffende host is: https://api.paazl.com/v1

Integratiestappen

Het onderstaande schematische diagram geeft een overzicht van de stappen die je moet nemen om de checkout-functionaliteit van Paazl aan jouw checkout-pagina toe te voegen met behulp van de Paazl REST API.

Zie de Paazl REST API-referentie voor meer informatie over elk endpoint en elke methode.

Waarom bestellingen opslaan?

De belangrijkste redenen om de gegevens van een bestelling op te slaan zodra de betaling door jouw klant is bevestigd, zijn dat je op een later moment:

• verzendlabels kunt printen in jouw magazijn;
• track & trace-notificaties kunt verzenden zodra de bestelling is verzonden.

Gebruik de POST order-methode om de gegevens van een bestelling voor de eerste keer op te slaan in de Paazldatabase. Zie de Paazl REST API-referentie voor meer informatie over deze methode.

Bestelgegevens wijzigen

Als je de gegevens van een opgeslagen bestelling wilt wijzigen, gebruik je de PUT order-methode. Zie de Paazl REST API-referentie voor meer informatie over deze methode.