Skip to content

v1.0.0 ​

Primeira versão pública da API de Parceiros.

Endpoints ​

  • GET /partners/ping: confere chave, escopos e conectividade.
  • GET /partners/leads: lista os leads disponíveis para contato, com filtro por produto, fluxo, etapa e tempo parado.
  • GET /partners/planos: tabela de planos vigente, em faixas de quantidade.
  • POST /partners/resultados-chamada: grava o resultado de uma ligação no card do lead, idempotente por id_chamada.

Características ​

  • Autenticação por chave fixa em x-api-key, com escopo por chave.
  • Teto de chamadas por minuto, por chave, com Retry-After no 429.
  • Envelope success em toda resposta. Erro nunca sai com 200.
  • Datas em ISO 8601 com fuso, na ida e na volta.

Documentação das integrações da Chaves na Mão