API e Webhooks
Para que serve
Além das automações e da IA, o Tesselys conversa com outros sistemas da sua empresa por dois caminhos:
| Caminho | Direção | Para quê |
|---|---|---|
| API Externa | O seu sistema chama o Tesselys | Ler e gravar dados (pessoas, negócios, lançamentos, produtos, projetos, cotações, contratos, chamados, apontamentos de horas, pedidos de compra e cobranças) sem uma pessoa logada |
| Webhooks | O Tesselys chama o seu sistema | Avisar outro sistema, na hora, quando um evento acontece no Tesselys |
Onde fica
| O quê | Caminho |
|---|---|
| Chave da API Externa | Sistema › Integrações › Integração de API (a tela se chama API Externa) |
| Webhooks | Sistema › Integrações › Inscrição de Webhook. O item só aparece se o plano da empresa incluir webhooks |
Antes de começar
- Para ver a tela API Externa, o seu perfil de acesso precisa permitir ver a integração de API.
- Para gerar ou regenerar a chave, o perfil precisa permitir criar. Para revogar, precisa permitir excluir.
- Combine com a equipe de TI onde a chave e o Secret vão ficar guardados antes de gerar: eles aparecem uma única vez.
Gerar a chave da API
- Abra Sistema › Integrações › Integração de API.
- Clique em Gerar API Key.
- Leia o aviso de exibição única e clique em Confirmar e Gerar.
- Na janela Credenciais Geradas com Sucesso, copie a API Key e o Secret com Copiar e guarde em local seguro.
- Marque Confirmo que copiei a API Key e o Secret em local seguro e clique em Entendi, Fechar.
Depois disso, a tela mostra API Key Ativa, com a data de criação e quem criou. O Secret não aparece mais.
Regenerar ou revogar a chave
- Regenerar API Key: gera credenciais novas. A chave atual é revogada na hora e todas as integrações que a usavam são desconectadas até receberem as novas credenciais.
- Revogar API Key: desliga a chave sem gerar outra. Para confirmar, digite REVOGAR e clique em Revogar. A tela passa a mostrar API Key Revogada, e você pode usar Gerar Nova API Key quando quiser reconectar.
Webhooks
Em Sistema › Integrações › Inscrição de Webhook, você cadastra a URL que vai receber os avisos e escolhe os eventos.
Como criar a inscrição, os eventos disponíveis e as novas tentativas de entrega: Webhooks.
Documentação técnica
Para a equipe de TI que vai construir a integração. O endereço base da API Externa é https://erp-api.ideros.api.br/external/v1.
Regras importantes
| Regra | Detalhe |
|---|---|
| Uma chave por empresa | Gerar uma chave nova revoga a anterior |
| Secret | Aparece uma única vez, na geração. Não é possível recuperá-lo depois |
| Revogar | Desliga a chave na hora. As integrações param até você gerar uma nova |
| Limite de uso | A API está sujeita a um limite de uso. Acima dele, ela recusa temporariamente as chamadas com o código 429 |
| Endereço da API | https://erp-api.ideros.api.br/external/v1 |
| Sem pessoa logada | A API usa uma conta de serviço da empresa, criada junto com a chave e desativada quando a chave é revogada |
Perguntas frequentes
Webhook e automação são a mesma coisa?
Não. A automação executa ações dentro do Tesselys. O webhook só avisa um sistema externo de que algo aconteceu, e o que acontece depois fica por conta desse sistema.
Perdi o Secret. Consigo ver de novo?
Não. O Secret só aparece na geração. Use Regenerar API Key para obter credenciais novas e atualize o seu sistema. A chave antiga para de funcionar na hora.
Não vejo o botão Gerar API Key. Por quê?
O seu perfil de acesso não permite criar a integração de API. Peça ao proprietário ou a um administrador da empresa.
Não encontro Inscrição de Webhook no menu. Por quê?
O item só aparece quando o plano da empresa inclui webhooks e o seu perfil permite ver as inscrições.
A nossa equipe ajuda você a configurar e usar esse recurso.