Duas chamadas bastam para integrar: pedir uma recomendação e registrar sinais. São HTTP com JSON, e o SDK não faz nada que você não possa fazer com elas.

As cinco operações

O estado do processo vive na raiz do servidor, fora de /v1 e de /salespilot.

O percurso mínimo

Uma recomendação (na API, Decision: a lista de produtos recomendados para aquele momento) e o sinal de que foi exibida, amarrado ao seu decision_id. Com os dois, ela aparece na sua loja e é medida.

Convenções que valem para tudo

  • A loja sai da chave, nunca do corpo: O que a CrossUp decide. Um produto de outra loja dá 404, como um inexistente.
  • Os ids têm prefixo. cn_, itm_, var_, dec_, sig_, vis_, ses_, spk_. Trate-os como opacos.
  • Os textos são por idioma: objetos { idioma: texto } com pelo menos uma chave, sem idioma garantido.
  • O ausente é desconhecido, não zero nem falso.
  • As datas são RFC 3339 em UTC.
  • Os erros têm forma fixa: Erros.
  • Tentar de novo é seguro onde há um id estável: o do sinal.

O contrato

A fonte da verdade é platform-api-v1.yaml, em OpenAPI 3.1. Dele saem o SDK, esta referência e os fixtures dos testes.

Cota e cache

Sessenta por minuto, Retry-After, e o que guardar em cache.

Versionamento

O que pode mudar sem aviso e o que não.