API

Dois endpoints, somente leitura. Eles devolvem o que o pipeline encontrou para a sua conta: as empresas que ele leu e as que passaram por todas as etapas. Tudo o que o painel mostra nessas duas telas está disponível aqui, em JSON, para essa mesma conta e nenhuma outra.

Autenticação

Crie uma chave no painel, em Configurações. Ela aparece uma única vez, porque só o hash dela é guardado, então não existe tela capaz de revelá-la depois. Envie-a como token bearer.

curl https://knockwire.com/api/reads \
  -H "Authorization: Bearer kw_live_..."

Uma requisição sem chave, com cabeçalho malformado ou com chave revogada recebe um 401 com um corpo JSON explicando qual dos três. Uma chave lê todas as empresas e todas as recusas da conta dela, então merece o mesmo cuidado que uma senha. Revogar uma chave em Configurações passa a valer já na requisição seguinte.

Endpoints

• GET /api/reads Todas as empresas que o pipeline examinou, das mais recentes para as mais antigas. Filtre com outcome=refuse ou outcome=knock. O padrão são as recusas, porque as recusas são a parte que vale a leitura. limit é 100 por padrão e fica limitado a 500.
• GET /api/prospects As empresas que passaram pelas quatro etapas, com a pontuação e o raciocínio por trás dela.

Não existe parâmetro de conta. A chave decide de quem são os dados que voltam, e uma requisição que carregue tenant= é recusada com um 400 em vez de ser ignorada em silêncio.

O que esta API ainda não faz

Escrito aqui para que ninguém descubra no meio de uma integração.

• Sem escrita. Não há endpoint que aceite uma lista de empresas. A descoberta lê as próprias fontes.
• Sem envio. Nada nesta API pode aprovar nem entregar uma mensagem. A aprovação é uma pessoa no painel, e isso é uma decisão de produto, não um recurso faltando.
• Sem prefixo de versão. Os caminhos não têm versão enquanto o formato ainda estiver mudando. Quando isso mudar, será anunciado no changelog.
• Sem limite de uso publicado. Hoje não há nenhuma restrição por chave. Seja razoável, e espere que uma apareça antes de ser necessária, e não depois.