Configuración de la integración con Cayena

La configuración está en Integração Cayena, en el menú de registros de integración.

Seleccione la empresa antes de crear o editar el registro. Cada empresa tiene un solo registro.

En el alta, guarde el registro y ábralo de nuevo en edición para liberar el botón Gerar del token.

Pestaña General

Campo	Uso
Token	Secreto de la empresa. Cayena envía este valor como `clientSecret`. El código de la empresa es el `clientId`.
Ativo	Enciende o apaga la API de esta empresa. Desmarcado, la autenticación se rechaza.

Copiar copia el token. Gerar cambia el valor. Después de generarlo de nuevo, Cayena debe actualizar el clientSecret. Los tokens de acceso ya emitidos dejan de valer.

Pestaña Pedido

Estos campos valen para todo pedido que Cayena envíe. Cayena no elige vendedor, lista, sucursal ni condición en la llamada.

Campo	Obligatorio	Uso
Vendedor	Sí	Vendedor grabado en el pedido. La numeración del pedido sigue el rango de este vendedor.
Lista de preço	Sí	Solo los productos con precio en esta lista entran en el catálogo y pueden venderse.
Filial	No	Se graba en el pedido cuando está llena.
Tipo de pedido	No	Se graba en el pedido. Vacío: Demander usa el tipo 1.
Condição de pagamento	No	Se graba en el pedido cuando está llena.
Status inicial	Sí	Estado del pedido aceptado. En el de-para, este código debe usar `orderStatus` CONFIRMED.

Use un vendedor con rango de numeración disponible. Si el rango se agotó, el pedido no se graba.

Pestaña De-para

El JSON une los códigos de Demander con los textos que Cayena recibe.

Estado

Cada ítem tiene codStatus, orderStatus, entregue y cancelado.

El estado inicial de la pestaña Pedido entra en la lista con orderStatus CONFIRMED.
entregue true solo en el estado en que el pedido fue entregado. Ese estado hace que la consulta de estado devuelva la fecha de entrega.
cancelado true marca el estado de cancelación. El texto enviado a Cayena es el orderStatus, por ejemplo CANCELED.
No repita el mismo codStatus.
Incluya todo estado que el pedido pueda asumir después de aceptado. Un estado fuera de la lista hace fallar la consulta del pedido.

El mismo número de pedido de Cayena no crea otro pedido, esté confirmado, entregado o cancelado.

Unidad

Cada ítem tiene sigla y descricao. La sigla es la unidad del producto en Demander. La descripción es el texto enviado a Cayena y no puede ser igual a la sigla.

Incluya toda unidad usada en la lista de precios. Si un producto de la página no tiene unidad, o la sigla no está en el de-para, falla el listado del catálogo de esa página entera.

Ejemplo mínimo:

{
  "deParaStatus": [
    {
      "codStatus": 1,
      "orderStatus": "CONFIRMED",
      "entregue": false,
      "cancelado": false
    },
    {
      "codStatus": 2,
      "orderStatus": "DELIVERED",
      "entregue": true,
      "cancelado": false
    },
    {
      "codStatus": 3,
      "orderStatus": "CANCELED",
      "entregue": false,
      "cancelado": true
    }
  ],
  "deParaUnidade": [
    { "sigla": "UN", "descricao": "Unidade" },
    { "sigla": "CX", "descricao": "Caixa" }
  ]
}

Cambie los códigos por los estados reales de la empresa. El codStatus del ítem CONFIRMED tiene que ser el mismo Status inicial de la pestaña Pedido.

Logs

Las llamadas quedan en Logs de integração Cayena. El atajo también está en el aviso del listado.

La grilla muestra fecha, método, endpoint, HTTP, éxito, duración, pedido y número de Cayena. La petición y la respuesta guardan el cuerpo, con token, secreto, correo, teléfono y documento enmascarados. El listado de productos guarda solo el resumen de la página, no el catálogo entero.

Los logs se excluyen después de 15 días.

Contrato de las llamadas: API de Cayena.