API Pública de Cortecloud
Cortecloud es la plataforma en la que los carpinteros, profesionales que diseñan y arman muebles, encargan piezas cortadas a medida a centrales de servicio, las empresas que venden los materiales y producen esas piezas. En este portal, "central" es siempre la central de servicio. Los demás términos están definidos en Conceptos.
La API Pública permite integrar el sistema de una central (ERP, sistema de ventas, checkout de pago) con Cortecloud. Con ella, su integración puede:
- mantener el precio, el stock y el estado activo/inactivo de los materiales de la central: tableros, tapacantos y componentes (Materiales);
- consultar los servicios (pedidos) de la central, asociarlos a los pedidos de su ERP y enviarlos a producción (Obtener servicios y Actualizar servicios);
- recibir un aviso en cada cambio de estado de un servicio, sin consultar
GET /servicesrepetidamente (Webhooks); - recibir el pago en línea de un servicio en un checkout de su sistema (Checkout de pago);
- abrir pantallas de Cortecloud ya autenticadas para vendedores y carpinteros, sin que tengan que escribir usuario y contraseña (Inicio de sesión integrado).
Para quienes desarrollan software de diseño de muebles, el portal también documenta el formato del archivo JSON con el que el carpintero importa piezas, perforaciones y mecanizados a un servicio (Importación por archivo JSON). Esa integración se hace por archivo y no usa la API.
Entornos
| Entorno | URL base |
|---|---|
| Homologación | https://apis.hml.cortecloud.com.br |
| Producción | https://apis.cortecloud.com.br |
Cada entorno tiene credenciales propias. Los ejemplos usan paths relativos (/services, /materials/boards): antepóngales la URL base del entorno.
Primeros pasos
- Solicite las credenciales (api key y secret key) a suporte@serrabits.com.br. Indique que usted es integrador, qué central va a integrar y en qué entorno. Si no conoce el código de la central, solicítelo en el mismo mensaje.
- Implemente la firma de las solicitudes según Autenticación y compruebe el resultado con los valores de validación.
- Lea Errores, límites y paginación antes de escribir ciclos de sincronización.
- Siga la guía de su caso de uso, primero en homologación y después en producción.
Cómo está organizada esta documentación
- Guías (esta parte): conceptos, autenticación y el paso a paso de cada tipo de integración.
- Referencia de la API: Swagger con todas las rutas, parámetros, cuerpos y respuestas. Es la fuente de verdad sobre el formato de cada ruta; las guías remiten a la operación correspondiente.
- Playground: colección de Bruno con una solicitud de ejemplo para cada ruta, en el entorno de homologación. Abierta en Bruno, la colección firma cada solicitud por sí sola. Para usarla:
- abra la colección en Bruno con el botón "Open in Bruno";
- active el Developer Mode de Bruno (el script de firma usa el módulo
crypto); - en el environment
HML, completeapiKeyysecretKeycomo secrets ycompanyInternalCodecon el código de la central.