La REST API ChannelDock vous permet de connecter votre propre logiciel à ChannelDock et de travailler avec les commandes, produits, expéditions, retours et mises à jour de stock.

La liste complète des endpoints, les détails d’authentification, les exemples de requêtes et les exemples de réponses sont disponibles dans notre documentation API ici :

https://docs.channeldock.com

Que pouvez-vous faire avec la REST API ?

• Récupérer les commandes et leurs mises à jour

• Lire les informations produit et stock

• Créer ou mettre à jour des expéditions, selon l’endpoint

• Construire des intégrations personnalisées entre ChannelDock et votre ERP, WMS ou boutique en ligne

Premiers pas

1. Connectez-vous à ChannelDock et allez dans Settings -> API & Webhooks.

2. Dans la section API keys, cliquez sur Generate new API keys.

3. Donnez des identifiants avec une description claire pour reconnaître l’intégration plus tard.

4. Stockez la clé API et le secret API dans un emplacement sécurisé.

5. Consultez la documentation API pour examiner les endpoints disponibles, les paramètres requis et les exemples de payload avant de commencer le développement.

Authentification et sécurité

Chaque requête API doit être authentifiée avec vos identifiants API. Gardez votre clé API et votre secret API privés et ne les exposez jamais dans le code frontend ou des dépôts publics.

Nous recommandons de créer une clé API distincte pour chaque intégration et de limiter les permissions des endpoints, afin de gérer l’accès et de faire tourner les identifiants si nécessaire.

Limitation du débit

La REST API ChannelDock applique une limitation du débit par clé API. Par défaut, une clé API peut effectuer jusqu’à 1000 requêtes par heure.

Chaque réponse API inclut les en-têtes de limitation suivants :

• X-RateLimit-Limit

• X-RateLimit-Remaining

• X-RateLimit-Reset

Si la limite est dépassée, l’API renvoie une réponse HTTP 429 avec le message :

API call limit exceeded. Please try again later.

Nous recommandons de surveiller les en-têtes X-RateLimit-Remaining et X-RateLimit-Reset dans votre intégration afin de ralentir les requêtes avant d’atteindre la limite.

Bonnes pratiques

• Commencez par tester vos requêtes dans un environnement de développement avant de les déployer en production.

• Limitez les permissions des endpoints aux seules méthodes dont votre intégration a besoin.

• Utilisez les webhooks si vous avez besoin de mises à jour quasi en temps réel au lieu de interroger l’API en continu.