API documentatie

Onderwerp: Alles wat je moet weten over het integreren van je op maat gemaakte webshop met Sendcloud via onze (RESTful) API’s. 

Gerelateerde links:

• Sendcloud API-referentie
• Sendcloud Developer Portal
• Servicepunten voor API-integraties
• Sendcloud API’s FAQ 
• Integratierichtlijnen voor marketplaces

Bij Sendcloud bieden we functies en tools die e-commercebedrijven helpen hun verzendproces te automatiseren. Onze volledig schaalbare functies maken het leven van online retailers eenvoudiger, of je nu een eenmanszaak of start-up bent, of een grote onderneming die duizenden pakketten per maand wereldwijd verzendt. 

Integreren met Sendcloud

Er zijn twee manieren om je webshop te koppelen aan Sendcloud:

Plug-and-play integraties

Als je een e-commerceplatform gebruikt zoals Shopify, WooCommerce, Lightspeed of Magento, heb je geen ontwikkelvaardigheden nodig om je winkel te koppelen. Wij bieden plug-and-play apps en plugins voor meer dan 80 van de populairste e-commerceplatforms, beschikbaar om te downloaden via de marketplace of app store van jouw systeem.

Sendcloud API

Heb je een op maat gemaakte webshop die niet is gehost of gebouwd via een e-commerceplatform, dan komen onze API’s in beeld. Een API stelt ontwikkelaars in staat om verbinding te maken met en belangrijke onderdelen van ons interne systeem te gebruiken en te integreren met jouw webshop of systeem. De Sendcloud API’s zijn ontworpen om elke fase van het verzendproces te ondersteunen.

Onze functies kunnen gecombineerd of afzonderlijk worden gebruikt, wat je de flexibiliteit geeft om je eigen workflow van begin tot eind te ontwerpen en op te bouwen. Met onze API’s krijg je toegang tot een breed scala aan nationale en internationale verzendopties van de populairste Europese commerciële en postvervoerders. 

Documentatie en API-referentie 

Ben je een ervaren ontwikkelaar en wil je snel starten met onze API’s? Ga dan direct naar onze API-referentie of bekijk onze Postman Collections.

Ben je nieuw met API’s en wil je een uitgebreide uitleg over hoe je orderverwerkingsworkflow eruit kan zien? Bekijk dan onze API-documentatie. We bieden quickstartgidsen en tutorials die je door de basisprincipes leiden, van het aanmaken van je eerste order en het verzenden ervan met de API tot het aanmaken van je eerste zending en het vergelijken van verzendtarieven.

Wat kun je doen met onze API’s?

• Orders API
  De Orders API helpt je om je bestellingen op een eenvoudige en flexibele manier voor te bereiden voor verzending.

• Ship an Order API
  De Ship an Order API is een alles-in-één oplossing voor het aanmaken van verzendlabels voor je bestellingen. Verzenden omvat verschillende belangrijke gegevens, zoals gewicht, voorkeursvervoerder, land van bestemming en verzekering. De Ship an Order API maakt het eenvoudig om dit hele proces te automatiseren.

• Shipments API
  Je kunt zendingen programmatisch aanmaken en beheren met de Shipments API. Hiermee kun je de volledige levenscyclus van een zending automatiseren zonder handmatige invoer in het platform, terwijl je gebruik blijft maken van je verzendregels en standaardinstellingen.
  Alle zendingen blijven zichtbaar in je Sendcloud-account, zodat je ze kunt controleren, problemen kunt oplossen of aanpassen wanneer nodig.

• Service Points API
  Integreer een servicepuntkiezer in je checkout, krijg toegang tot een wereldwijde database met servicepuntlocaties van vervoerders en laat je klanten een handige afleverlocatie voor hun pakket kiezen.

• Returns Portal API
  Laat je klanten hun eigen retouren beheren door een aangepaste versie van het Return Portal te bouwen. Je kunt dit combineren met de betaalde retourenfunctie om proactief retourkosten in rekening te brengen wanneer nodig.

• Tracking API
  Haal de volledige trackinggeschiedenis van een pakket op, vanaf het moment dat het wordt aangemeld bij de vervoerder tot aan levering bij je klant.

• Pick-ups API
  Plan een eenmalige afhaling met een vervoerder via de Pick-ups API en laat je pakketten ophalen bij je magazijn of winkel binnen een geselecteerd tijdvenster.

• Dynamic Checkout API
  Verhoog je conversieratio door next-day, same-day en bezorging op een gekozen dag direct in je checkout aan te bieden. Configureer verzendmethoden per bezorgzone in het panel en gebruik vervolgens de API om de beschikbare methoden op te halen en aan je klanten te tonen tijdens het afrekenen.

• Returns API
  Maak losse retouren aan met de Returns API, zelfs als het pakket oorspronkelijk niet via je account is verzonden. Krijg toegang tot een database met beschikbare retourmethoden en valideer je retourverzoek voordat je het label genereert, zodat je onnodige kosten voorkomt als de gekozen retourmethode niet van toepassing is. 

Wat is een API?

API staat voor Application Programming Interface. Een API stelt applicaties in staat om via het web met elkaar te communiceren. Om gegevens van een API op te halen, doe je een “request” in een opmaaktaal zoals JSON of XML, of in een programmeertaal zoals Python, naar een server. De server retourneert vervolgens de gevraagde gegevens in een “response”. API’s zijn niet slechts een database—naast het opvragen van gegevens kun je ook gegevens bijwerken, aanmaken en verwijderen door API-verzoeken naar specifieke endpoints te sturen.

De Sendcloud API geeft je bijvoorbeeld toegang tot het “Create a Shipment”-endpoint. Je kunt een verzoek naar dit endpoint sturen om een zending in het Sendcloud-systeem aan te maken door de benodigde informatie mee te geven (adresgegevens, verzendoptiegegevens en meer). Om een request te doen, moet je weten welke informatie onze server nodig heeft om de zending aan te maken. In onze API-referentie vind je voorbeeldrequests en -responses, plus een lijst met verplichte en optionele velden die je kunt meegeven.

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

Ontwikkelaars gebruiken API’s om specifieke functies in een bestaande, op maat gemaakte webshop of systeem te bouwen. Door via de API met Sendcloud te verbinden, kun je onze functies aanpassen aan jouw bedrijfsbehoeften en ze integreren met applicaties van derden, bijvoorbeeld voor facturatie en magazijnbeheer. 

Wanneer je via een API met Sendcloud integreert, heb je volledige flexibiliteit om te bepalen hoe je je orderverwerking en logistieke workflow opzet. Je kunt ervoor kiezen om bestellingen direct via de API te verwerken of om ze in het Sendcloud-panel te importeren en daar te verwerken. Omdat onze API je afzonderlijk toegang geeft tot onze belangrijkste functies, kun je zelf bepalen welke functies je wilt gebruiken en deze direct in je systeem en workflow integreren. 

Aan de slag 

Klaar om te starten met de integratie van de Sendcloud API’s? Zorg ervoor dat je een Sendcloud-account hebt aangemaakt en de stappen in onze Aan de slag met Sendcloud-gids hebt gevolgd.

Je moet de volgende stappen voltooien voordat onze API je verzoeken accepteert:

1. Je afzender- en (optioneel) retouradressen configureren
2. Enkele vervoerders activeren in je account
3. Een betaalmethode instellen (verplicht voordat je verzendlabels kunt aanmaken). Lees meer over hoe Sendcloud je kosten voor aangemaakte verzendlabels factureert hier. 

Optioneel: Vergeet niet een brand aan te maken, tracking meldingen in te schakelen en je Return Portal aan te maken. 

Authenticatie

Sendcloud gebruikt Basic Authentication om verzoeken voor onze API’s te authenticeren. Je moet een `Public` en `Private` API-sleutel opnemen in de header van elke call die je naar een Sendcloud-endpoint maakt. 

Voorbeeld: 

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

Raadpleeg de Authentication-sectie van ons Developer Portal voor meer voorbeelden over het authenticeren met onze API’s. 

Hoe verkrijg je je API-sleutels

1. Log in op je Sendcloud-account en ga naar Instellingen > Integraties
2. Zoek Sendcloud API in de lijst met integraties en klik op Koppelen
3. Geef de API-integratie een naam (bijvoorbeeld “Mijn Webshop”) en klik op Opslaan
4. Je API Public- en Secret-sleutels worden automatisch gegenereerd. Kopieer ze en bewaar ze op een veilige plaats en voeg ze toe aan je request headers. De Public-sleutel is je “gebruikersnaam” bij het authenticeren met de API, en de Secret (Private)-sleutel fungeert als je “wachtwoord”. 

Servicepunten inschakelen

Op de pagina Integratie-instellingen, zoals hierboven beschreven onder Authenticatie, kun je servicepunten inschakelen of uitschakelen. Om API-verzoeken te doen naar de Service Point API, pakketten naar een servicepunt te verzenden of de servicepuntkiezer in je checkout weer te geven, moet je servicepunten inschakelen.

Nadat je het vakje hebt aangevinkt om servicepunten in te schakelen, kun je de vervoerders selecteren die je wilt opnemen als servicepunt-bezorgmethoden en klik je op Opslaan. 

Testlabels aanmaken

Je kunt onze API’s testen zonder onverwachte kosten door gebruik te maken van de Sendcloud-verzendoptie ‘Ongefrankeerde brief’ ("shipping_option_code": "sendcloud:letter"). Voor meer hulp bij het aanmaken van testlabels via de API, zie onze documentatie.

Veelgestelde vragen

Heb je vragen over het gebruik van onze API’s? Bekijk dan onze Sendcloud API’s - FAQ-gids.

IP-adressen om te whitelisten