API documentatie

Onderwerp: Alles wat je moet weten over het integreren van je zelfgebouwde webshop met Sendcloud via onze (RESTful) API's.  

Gerelateerde links:

• Sendcloud API Reference
• Sendcloud Developer's Portal
• Service points for API integrations
• API Integration FAQ's
• Integration guidelines for Marketplaces

Bij Sendcloud bieden we features en hulpmiddelen die e-commerce bedrijven helpen om hun verzendproces te automatiseren. Onze volledig schaalbare functionaliteiten maken het leven van online retailers makkelijker, of je nu een eenmanszaak of een startend bedrijf bent, of een grootschalige onderneming die duizenden pakketten per maand over de hele wereld verzendt. 

Integreren met Sendcloud

Er zijn twee manieren om je webshop met Sendcloud te verbinden:

Plug & play integraties

Als je een e-commerce systeem gebruikt zoals Shopify, WooCommerce, Lightspeed en Magento, heb je geen ontwikkelingskennis nodig om je shop aan te sluiten. We bieden plug-and-play apps en plugins voor 80+ van de populairste e-commerce platforms, die je kunt downloaden via de marketplace of app-store van je specifieke systeem.
Meer informatie over het integreren van je webshop, marktplaats, ERP of WMS systeem vind je in de Integratie sectie van ons Helpcentrum. 

Sendcloud API

Als je een op maat gemaakte webshop hebt die niet via een e-commerce platform wordt gehost en gemaakt, dan komen daar onze API's om de hoek kijken. Een API biedt ontwikkelaars de mogelijkheid om te verbinden met belangrijke elementen binnen ons interne systeem en deze vervolgens te linken aan jouw webshop of systeem. 

Sendcloud API's zijn ontworpen om elk stadium van het verzendtraject te omvatten.
Onze functies kunnen in combinatie met elkaar gebruikt worden, of los van elkaar, wat je de flexibiliteit geeft om je eigen workflow van begin tot eind te ontwerpen en op te bouwen. Onze API's geven je toegang tot een enorme reeks nationale en internationale verzendmethoden van de populairste Europese commerciële en postale vervoerders. 
Klaar om te beginnen? Lees verder om te zien hoe je snel aan de slag kunt met onze API's.

Documentatie en API Reference 

Als je een ervaren ontwikkelaar bent die snel met onze API's aan de slag wilt, kun je direct naar onze API Reference of Postman Collections gaan.

Ben je nieuw met API's en wil je een diepgaande uitleg over hoe je proces voor orderverwerking eruit zou kunnen zien, bekijk dan onze API Documentatie. We bieden quick start guides en handleidingen aan om je door de basis elementen te leiden, van het aanmaken van je eerste zending via de API tot het aanmaken van Multicollo zendingen en het vergelijken van Verzendtarieven. 

Wat kun je doen met onze APIs?

• Shipping API
  De Shipping API geeft je toegang tot de kernfuncties van ons platform. Maak labels aan, vergelijk tarieven, genereer douanedocumenten voor je internationale zendingen en automatiseer je verzendkeuzes met verzendregels.
• Service Points API
  Integreer een servicepuntkiezer in je checkout, krijg toegang tot een database van alle beschikbare servicepunten van vervoerders over de hele wereld en laat je klanten een handige locatie kiezen om hun pakket te laten bezorgen.
• Shipping Products API
  Vergelijk tarieven, serviceniveaus en diverse verzendmethodes bij 50+ maatschappijen op zowel nationale als internationale schaal.
• Return Portal API
  Laat je klanten hun eigen retouren beheren door je eigen aangepaste versie van het Sendcloud Retourportaal te bouwen. Gebruik het in combinatie met onze betaalde retourfunctie om je klanten proactief retourkosten in rekening te brengen.
• Tracking API
  Vraag de hele tracking geschiedenis van een pakket op, vanaf het moment dat het pakket wordt aangekondigd tot het precieze moment dat het bij je klant aankomt.
• Pickups API
  Plan een eenmalige afhaling met een vervoerder via de Pickups API en laat je pakketten binnen een bepaald tijdvenster bij je magazijn of winkel ophalen.
• Returns API V3
  Maak losstaande retourzendingen aan voor pakketten via de Retouren API, zelfs als het pakket niet oorspronkelijk via je Sendcloud account is verzonden. Krijg toegang tot een database van retourmethoden en valideer je retourverzoek voordat je het label aanmaakt, zodat je ongewenste kosten kunt vermijden als een retour niet mogelijk is met de gekozen retourmethode.
• Dynamic Checkout API
  Verhoog je conversie door leveringen op de volgende dag, dezelfde dag of een specifieke dag rechtstreeks vanaf je checkout pagina aan te bieden. Configureer verzendmethoden per leverzone met behulp van het Sendcloud panel, haal vervolgens de toepasselijke verzendmethoden op en presenteer ze aan je klant op je checkout pagina met onze API.

What is an API?

API staat voor Application Programming Interface. Een API staat applicaties toe om via het web met elkaar te communiceren. Om gegevens uit een API op te vragen doe je een "request" in een formatting taal zoals JSON of XML, of een programmeertaal zoals Python, aan een server en de server stuurt de gevraagde gegevens terug in een "response". API's zijn niet alleen een databank - naast het opvragen van gegevens kun je ook gegevens bijwerken, creëren en verwijderen door API requests te doen aan specifieke eindpunten.

De Sendcloud shipping API geeft je bijvoorbeeld toegang tot het endpoint "Create a parcel". Je kunt dit endpoint aanroepen om een pakket in het Sendcloud systeem aan te maken door het endpoint de informatie te geven die het nodig heeft (adresinformatie, verzendmethode informatie, enz). Om een request te doen, moet je weten welke informatie onze server nodig heeft om het pakket te maken. 

We geven voorbeeld requests en responses, plus een lijst van verplichte en optionele velden die je kunt opgeven, in onze API reference.

Waarom een API gebruiken in plaats van een plug-and-play integratie?

Ontwikkelaars gebruiken API's om specifieke features in te bouwen in een bestaande, zelfgebouwde webshop of systeem. Verbinding maken met Sendcloud via de API stelt je in staat onze features aan te passen aan je zakelijke behoeften. Bovendien kun je onze features integreren en gebruiken naast applicaties van derden die te maken hebben met facturering en magazijnbeheer. 
Als je met Sendcloud integreert via een API, heb je de volledige flexibiliteit om te beslissen hoe je je orderverwerking en logistieke workflow wilt opbouwen. Je kunt ervoor kiezen om je orders direct via de API te verwerken, of orders in het Sendcloud panel te importeren en ze vanuit daar te verwerken. Gezien onze API je individueel toegang geeft tot onze belangrijkste features, kun je zelf beslissen van welke features je gebruik wilt maken en ze direct in je systeem en workflow opnemen. 

Aan de slag

Klaar om aan de slag te gaan en te integreren met Sendcloud API's? Voordat je begint, moet je eerst een Sendcloud account hebben aangemaakt en de stappen in Welkom bij Sendcloud hebben gevolgd.

Je moet de volgende stappen doorlopen voordat onze API je requests zal accepteren:

1. Configureer je afzend- en retouradressen (retouradressen optioneel)
2. Activeer enkele vervoerders in je account
3. Stel een betalingsmethode in (vereist voordat je verzendlabels kunt maken). Lees hier meer over hoe Sendcloud je factureert voor de verzendlabels die je maakt. 

Optioneel: Vergeet niet een brand aan te maken, tracking notificaties in te schakelen en je Retourportaal aan te maken.

Authenticatie

Sendcloud gebruikt Basic Authentication om requests te authenticeren voor onze APIs. Je moet een `Public` en `Private` API key opnemen in de header van alle aanroepen die je naar een Sendcloud endpoint doet. 

Voorbeeld: 

curl “https://panel.sendcloud.sc/api/v2/parcels” --user “YOUR_API_KEY:YOUR_API_SECRET”

Raadpleeg de sectie Authentication van ons Developers portal voor meer voorbeelden over authenticeren met onze API's. 

Hoe verkrijg je API sleutels

1. Log in bij je Sendcloud account en ga naar Instellingen > Integraties
2. Vind Sendcloud API in de lijst met integraties en klik op Koppelen
3. Geef de API integratie een naam (bijvoorbeeld: “My Webshop”) en klik op Opslaan
4. Je API Public en Secret keys worden automatisch gegenereerd. Kopieer deze, bewaar ze op een veilige plek en voeg ze toe aan je headers. De Public key is je “username” wanneer je moet authenticeren met de API en de Secret (Private) key functioneert als je "password". 

Servicepunten inschakelen

Op de Integratie instellingen pagina, zoals hierboven beschreven in Authenticatie, kun je kiezen om servicepunten in- of uit te schakelen. Om API requests aan de servicepunt API te doen om zo pakketten naar een servicepunt locatie te verzenden of om de servicepuntkiezer in je checkout te tonen, moet je servicepunten inschakelen.

Als je het vakje hebt aangevinkt om servicepunten in te schakelen, kun je de vervoerders kiezen die je als servicepunt verzendmethoden wilt opnemen en klik je op Opslaan. 

Testlabels aanmaken

Je kunt onze API's testen zonder je zorgen te maken over onverwachte kosten door de Sendcloud verzendmethode "Unstamped letter" (Ongefrankeerd label) te gebruiken. Voor meer hulp bij het aanmaken van testlabels met de API, zie onze documentatie.

Veelgestelde vragen

Als je vragen hebt over het gebruik van onze API's, kun je onze FAQ Gids voor API integraties raadplegen. 

IP-adressen om te whitelisten