Pular para o conteúdo principal

API do Kemera

A API é o caminho para outro sistema (ERP, site, sistema de gestão, o que for) conversar com o Kemera sem ninguém operar a tela: cadastrar contatos, abrir oportunidades, consultar conversas e agendamentos, e receber avisos quando algo acontece.

:::info Em preparação

A API pública ainda não está disponível. Esta seção já existe para que o endereço da documentação seja definitivo: quando a API for publicada, a referência completa (endpoints, campos, exemplos e códigos de erro) entra aqui, em docs.kemera.app/api, sem mudar o link que você já tem.

O endereço da API (o host para onde as chamadas vão) também será informado nesta página. Até lá, nenhuma integração com o Kemera é suportada fora das telas do sistema.

:::

O que já está decidido​

O desenho segue o da API do Firmou, também da KEMIS. Os pontos abaixo são os que afetam quem vai integrar; os detalhes podem ser ajustados até a publicação, e qualquer mudança aparece aqui primeiro.

  • O token é da empresa, não de uma pessoa. Quem emite é um administrador logado no Kemera, pela tela do sistema. Assim, desativar um usuário que saiu da empresa não derruba a integração. A própria API não emite nem renova tokens.
  • O token aparece uma única vez, no momento em que é criado. O Kemera guarda só uma impressão dele, e nem o suporte consegue recuperar o valor depois. Perdeu, revogue e emita outro.
  • Toda chamada leva o token no cabeçalho Authorization: Bearer.
  • Versão no caminho (/v1). Quando uma mudança quebrar contrato, ela sai numa versão nova, e a anterior continua funcionando.
  • Limite de chamadas por token, para que a integração de uma empresa não afete a de outra.
  • Conta sem plano ativo ou suspensa não usa a API, pela mesma regra que impede o login no sistema.

Webhooks​

Além de chamar a API, o seu sistema vai poder ser avisado pelo Kemera quando algo acontecer. Veja Webhooks.

Enquanto a API não sai​

  • Para operar o Kemera pela tela, use o Manual do sistema.
  • Para o chat no seu site, não é preciso API: o widget é instalado com um trecho de código, explicado em Canais.