Introdução
A API Externa Tesselys permite que o sistema da sua empresa (ERP próprio, BI, automações, site) leia e grave dados no Tesselys sem uma pessoa logada. Para ser avisado quando algo muda no Tesselys, use os webhooks.
Características
| Característica | Detalhe |
|---|---|
| Protocolo | REST sobre HTTPS |
| Formato | JSON (requisição e resposta), UTF-8 |
| Versão | No caminho: /external/v1 |
| Autenticação | API Key + Secret trocados por tokens (veja Autenticação) |
| Escopo | Uma chave por empresa; tudo o que a chave lê e grava é da empresa dona dela |
| Limites | Veja Rate limits |
| Disponibilidade | GET /external/v1/health, público |
URL base
https://erp-api.ideros.api.br/external/v1
Verificando a disponibilidade
curl https://erp-api.ideros.api.br/external/v1/health
{
"status": "ok",
"version": "v1",
"timestamp": "2026-11-17T14:30:00.000Z"
}
Esta rota é pública (não pede chave nem token). Use-a em monitoramento de disponibilidade.
Recursos disponíveis
Cada recurso só responde se a empresa tiver o recurso correspondente no plano. As regras de listagem, filtro e consulta por ID valem para todos e estão em Paginação e filtros.
Pessoas e produtos
| Recurso | Rota base | Operações |
|---|---|---|
| Pessoas | /persons | Listar, buscar, criar, atualizar |
| E-mails da pessoa | /person-emails | Listar, buscar, criar, atualizar |
| Telefones da pessoa | /person-phones | Listar, buscar, criar, atualizar |
| Produtos | /products | Listar, buscar, criar, atualizar |
CRM e vendas
| Recurso | Rota base | Operações |
|---|---|---|
| Leads | /leads | Listar, buscar, criar, atualizar |
| Negócios | /deals | Listar, buscar, criar, atualizar |
| Itens do negócio | /deal-items | Listar, buscar, criar, atualizar |
| Pipelines | /deal-pipelines | Listar, buscar |
| Atividades | /activities | Listar, buscar, criar, atualizar |
| Propostas | /quotes | Listar, buscar, criar, atualizar |
| Itens da proposta | /quote-items | Listar, buscar, criar, atualizar |
Contratos
| Recurso | Rota base | Operações |
|---|---|---|
| Documentos para assinatura | /signs | Listar, buscar, criar, atualizar |
| Contratos recorrentes | /contracts | Listar, buscar, criar, atualizar |
| Itens do contrato | /contract-items | Listar, buscar, criar |
Projetos
| Recurso | Rota base | Operações |
|---|---|---|
| Projetos | /projects | Listar, buscar, criar |
| Waves | /project-waves | Listar, buscar, criar, atualizar |
| Épicos | /project-epics | Listar, buscar, criar, atualizar |
| Tarefas | /project-tasks | Listar, buscar, criar |
| Equipe do projeto | /project-team-members | Listar, buscar, incluir ou mudar papel |
Financeiro
| Recurso | Rota base | Operações |
|---|---|---|
| Lançamentos financeiros | /financial-entries | Listar, buscar, criar |
| Categorias financeiras | /financial-categories | Listar, buscar |
| Contas bancárias | /bank-accounts | Listar, buscar |
| Medições | /measurements | Listar, buscar, criar |
| Notas fiscais | /invoices | Listar, buscar, criar |
| Cobranças | /charges | Listar, buscar |
| Provisionamentos | /provisioning | Listar, buscar, criar, atualizar |
Compras
| Recurso | Rota base | Operações |
|---|---|---|
| Pedidos de compra | /purchase-orders | Listar, buscar, criar, atualizar |
| Itens do pedido de compra | /purchase-order-items | Listar, buscar, criar |
RH e timesheet
| Recurso | Rota base | Operações |
|---|---|---|
| Perfis de colaboradores | /employee-profiles | Listar, buscar, criar, atualizar |
| Apontamentos de horas | /timesheet-entries | Listar, buscar, criar |
| Períodos de timesheet | /timesheet-periods | Listar, buscar, criar |
Help desk e SLA
| Recurso | Rota base | Operações |
|---|---|---|
| Chamados | /tickets | Listar, buscar, criar, atualizar |
| Comentários do chamado | /ticket-comments | Listar, buscar, criar |
| Políticas de SLA | /sla-policies | Listar, buscar |
Contabilidade
| Recurso | Rota base | Operações |
|---|---|---|
| Contas contábeis | /accounting-accounts | Listar, buscar |
| Lançamentos contábeis | /accounting-journal-entries | Listar, buscar |
| Partidas | /accounting-journal-entry-lines | Listar, buscar |
| Relatórios contábeis | /accounting-reports/... | Balancete, balanço, razão, extrato, resumo |
Configurações e consulta
| Recurso | Rota base | Operações |
|---|---|---|
| Centros de custo | /cost-centers | Listar, buscar |
| Unidades de negócio | /business-units | Listar, buscar |
| Campos customizados | /custom-fields | Listar, buscar |
Plataformas parceiras
| Recurso | Rota base | Operações |
|---|---|---|
| Aperto de mão | /integrations/:provider/connect | Conectar, desconectar |
| Pedidos de contratação | /hiring-requests | Receber pedido |
Não há rotas de exclusão: para inativar um registro, use a tela do Tesselys.
Começo rápido
1. Gere a API Key
No Tesselys, abra o menu lateral, seção Sistema, e entre em Integrações > Integração de API (tela API Externa). Clique em Gerar API Key. Só o Proprietário ou um Administrador da empresa gera a chave.
Você recebe:
- API Key:
tesselys_ak_seguido de 48 caracteres hexadecimais; - Secret: 27 caracteres.
A API Key e o Secret aparecem uma vez só. Copie e guarde os dois antes de fechar a janela. Se perder, gere uma nova chave (a anterior deixa de valer na hora).
2. Autentique
curl -X POST https://erp-api.ideros.api.br/external/v1/auth \
-H "Content-Type: application/json" \
-H "x-api-key: tesselys_ak_..." \
-d '{ "secret": "SEU_SECRET" }'
{
"accessToken": "eyJhbGciOiJSUzI1NiIs...",
"companyToken": "3f2b9c1e-6d4a-4b8e-9f0a-1c2d3e4f5a6b",
"expiresIn": 3600
}
3. Chame um recurso
curl https://erp-api.ideros.api.br/external/v1/persons \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "x-company-token: $COMPANY_TOKEN"
Pré-requisitos
- Conta ativa no Tesselys e uma pessoa com papel de Proprietário ou Administrador para gerar a chave.
- Os recursos que você vai usar contratados no plano da empresa.
- Acesso HTTPS de saída para
erp-api.ideros.api.br.
Próximos passos
- Autenticação: o fluxo completo e a renovação dos tokens
- Paginação e filtros: como listar e filtrar
- Rate limits: limites de uso e como tentar de novo
- Códigos de erro: formato dos erros
- Webhooks: avisos em tempo real
A nossa equipe ajuda você a configurar e usar esse recurso.