Configuração da integração com a Cayena

A configuração fica em Integração Cayena, no menu de cadastros de integração do Demander Web.

Selecione a empresa antes de incluir ou editar a configuração. Cada empresa pode ter somente um registro.

Aba Geral

Campo	Uso
Token	Credencial da empresa. A Cayena envia esse valor como `clientSecret`; o código da empresa é usado como `clientId`.
Ativo	Permite ou bloqueia o acesso da Cayena à API desta empresa. Quando desmarcado, a autenticação é recusada.

O botão Copiar copia o token atual. O botão Gerar substitui esse valor. Depois da troca, ajuste o clientSecret na Cayena. Os tokens de acesso emitidos com a credencial anterior deixam de funcionar.

Aba Pedido

A Cayena envia o número do pedido, o cliente, a data de entrega, os produtos, as quantidades e os preços. Vendedor, lista de preço, filial, tipo de pedido e condição de pagamento vêm desta aba e valem para todos os pedidos.

Campo	Obrigatório	Uso
Vendedor	Sim	O pedido é gravado com este vendedor e usa a faixa de numeração dele.
Lista de preço	Sim	Define os produtos e preços enviados no catálogo e usados para validar o pedido.
Filial	Não	Quando informada, é gravada no pedido.
Tipo de pedido	Não	Quando não informado, o Demander usa o tipo 1.
Condição de pagamento	Não	Quando informada, é gravada no pedido.
Status inicial	Sim	Primeiro status do pedido aceito. No de-para, este código deve corresponder ao `orderStatus` CONFIRMED.

Use um vendedor com faixa de numeração disponível. Se a faixa estiver esgotada, o pedido não é gravado.

Aba De-para

O JSON relaciona os status e as unidades do Demander aos valores usados pela Cayena.

Status

Cada item tem codStatus, orderStatus, entregue e cancelado.

Relacione o status inicial da aba Pedido ao orderStatus CONFIRMED.
Use entregue: true somente no status que representa a entrega. Quando o pedido chega a esse status, a consulta também devolve a data de entrega.
Use cancelado: true no status que representa o cancelamento. O valor devolvido à Cayena será o orderStatus, por exemplo CANCELED.
Não repita o mesmo codStatus.
Inclua todos os status que o pedido pode assumir depois de aceito. Se o status atual não estiver no de-para, a consulta do pedido falhará.

Unidade

Cada item tem sigla e descricao. A sigla identifica a unidade do produto no Demander; a descrição é o texto devolvido à Cayena e deve ser diferente da sigla.

Inclua todas as unidades usadas pelos produtos da lista de preço. Se um produto não tiver unidade ou sua sigla não estiver no de-para, a API não devolverá a página do catálogo que contém esse produto.

Exemplo 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" }
  ]
}

Substitua os códigos do exemplo pelos status reais da empresa. O codStatus relacionado a CONFIRMED deve ser igual ao campo Status inicial da aba Pedido.

Logs

As chamadas ficam em Logs de integração Cayena. O atalho também está no aviso da listagem.

A grade mostra data, método, endpoint, código HTTP, resultado, duração, código do pedido no Demander e número do pedido na Cayena. Os detalhes guardam os corpos da requisição e da resposta, com token, segredo, e-mail, telefone e documento mascarados. Na consulta de produtos, o log guarda somente o resumo da página, não o catálogo completo.

Os logs são excluídos depois de 15 dias.

Contrato das chamadas: API da Cayena.