De ChannelDock REST API stelt je in staat je eigen software met ChannelDock te verbinden en te werken met bestellingen, producten, zendingen, retouren en voorraadupdates.
De volledige lijst met endpoints, authenticatiedetails, requestvoorbeelden en responsevoorbeelden is beschikbaar in onze Postman-documentatie hier:
Wat kun je doen met de REST API?
- Bestellingen en updates van bestellingen ophalen
- Product- en voorraadinformatie lezen
- Zendingen aanmaken of bijwerken, afhankelijk van het endpoint
- Aangepaste integraties bouwen tussen ChannelDock en je ERP, WMS of webshop
Aan de slag
1. Log in op ChannelDock en ga naar Instellingen -> API & Webhooks.
2. Klik in de sectie API-sleutels op Genereer nieuwe API-sleutels.
3. Geef de inloggegevens een duidelijke omschrijving zodat je de integratie later kunt herkennen.
4. Bewaar de API-sleutel en het API-secret op een veilige plaats.
5. Open de Postman-documentatie om de beschikbare endpoints, vereiste parameters en voorbeeldpayloads te bekijken voordat je begint met bouwen.
Authenticatie en beveiliging
Elke API-aanvraag moet geauthenticeerd worden met je API-gegevens. Houd je API-sleutel en API-secret privé en maak ze nooit openbaar in frontend-code of publieke repositories.
We raden aan voor elke integratie een aparte API-sleutel aan te maken en de endpointrechten te beperken, zodat je toegang kunt beheren en referenties kunt vernieuwen wanneer dat nodig is.
Beperkingen voor verzoeken
De ChannelDock REST API hanteert limieten per API-sleutel. Standaard kan een API-sleutel tot 1000 verzoeken per uur doen.
Elke API-respons bevat de volgende rate limit-headers:
- X-RateLimit-Limit
- X-RateLimit-Remaining
- X-RateLimit-Reset
Als de limiet wordt overschreden, geeft de API een HTTP 429-respons terug met het bericht:
API-aanroeplimiet overschreden. Probeer het later opnieuw.
We raden aan de X-RateLimit-Remaining- en X-RateLimit-Reset-headers in je integratie te monitoren, zodat je verzoeken kunt afremmen voordat je de limiet bereikt.
Beste praktijken
- Begin met het testen van je requests in Postman voordat je ze in productie neemt.
- Beperk endpointrechten tot alleen de methoden die je integratie nodig heeft.
- Gebruik webhooks als je bijna realtime updates nodig hebt in plaats van de API continu te pollen.
Dit artikel is automatisch vertaald uit het Engels.