La REST API de ChannelDock le permite conectar su propio software a ChannelDock y trabajar con pedidos, productos, envíos, devoluciones y actualizaciones de stock.

La lista completa de endpoints, detalles de autenticación, ejemplos de solicitudes y ejemplos de respuestas está disponible en nuestra documentación API aquí:

https://docs.channeldock.com

¿Qué puede hacer con la REST API?

• Recuperar pedidos y actualizaciones de pedidos

• Leer información de producto y stock

• Crear o actualizar envíos, según el endpoint

• Construir integraciones personalizadas entre ChannelDock y su ERP, WMS o tienda online

Primeros pasos

1. Inicie sesión en ChannelDock y vaya a Settings -> API & Webhooks.

2. En la sección API keys, haga clic en Generate new API keys.

3. Asigne a las credenciales una descripción clara para reconocer la integración más tarde.

4. Guarde la clave API y el secreto API en un lugar seguro.

5. Abra la documentación API para revisar los endpoints disponibles, los parámetros requeridos y los payloads de ejemplo antes de empezar a desarrollar.

Autenticación y seguridad

Cada solicitud API debe autenticarse con sus credenciales API. Mantenga su clave API y secreto API privados y nunca los exponga en código frontend o repositorios públicos.

Recomendamos crear una clave API separada para cada integración y limitar los permisos de endpoints, para poder gestionar el acceso y rotar credenciales cuando sea necesario.

Limitación de tasa

La REST API de ChannelDock aplica limitación de tasa por clave API. Por defecto, una clave API puede realizar hasta 1000 solicitudes por hora.

Cada respuesta API incluye los siguientes encabezados de limitación:

• X-RateLimit-Limit

• X-RateLimit-Remaining

• X-RateLimit-Reset

Si se supera el límite, la API devuelve una respuesta HTTP 429 con el mensaje:

API call limit exceeded. Please try again later.

Recomendamos monitorizar los encabezados X-RateLimit-Remaining y X-RateLimit-Reset en su integración para ralentizar las solicitudes antes de alcanzar el límite.

Buenas prácticas

• Empiece probando sus solicitudes en un entorno de desarrollo antes de pasarlas a producción.

• Limite los permisos de endpoints solo a los métodos que su integración necesita.

• Use webhooks si necesita actualizaciones casi en tiempo real en lugar de consultar la API continuamente.