Introducao
A API Externa Tesselys permite que equipes de TI integrem sistemas terceiros (CRMs, automacoes, BI) com a plataforma Tesselys de forma segura e padronizada.
Caracteristicas
| Caracteristica | Detalhe |
|---|---|
| Protocolo | REST sobre HTTPS |
| Formato | JSON (request e response) |
| Encoding | UTF-8 |
| Versionamento | Via path (/v1) |
| Autenticacao | API Key + Secret → Bearer Token |
| Health Check | GET /external/v1/health (publico, sem autenticacao) |
Base URL
https://api.tesselys.com.br/external/v1
Todas as requisicoes devem utilizar HTTPS. Requisicoes HTTP plano serao rejeitadas.
Health Check
Antes de integrar, voce pode verificar se a API esta disponivel:
curl https://api.tesselys.com.br/external/v1/health
Resposta:
{
"status": "ok",
"version": "v1",
"timestamp": "2026-03-26T14:30:00.000Z"
}
Este endpoint e publico — nao requer API Key nem token. Use-o para monitoramento de uptime e verificacao de disponibilidade.
Recursos Disponiveis
Pessoas
| Recurso | Endpoint base | Operacoes |
|---|---|---|
| Pessoas | /external/v1/persons | Listar, buscar, criar, atualizar |
| Emails de Pessoa | /external/v1/person-emails | Listar, buscar, criar, atualizar |
| Telefones de Pessoa | /external/v1/person-phones | Listar, buscar, criar, atualizar |
Produtos
| Recurso | Endpoint base | Operacoes |
|---|---|---|
| Produtos | /external/v1/products | Listar, buscar, criar, atualizar |
CRM & Vendas
| Recurso | Endpoint base | Operacoes |
|---|---|---|
| Leads | /external/v1/leads | Listar, buscar, criar, atualizar |
| Negocios | /external/v1/deals | Listar, buscar, criar, atualizar |
| Itens de Negocio | /external/v1/deal-items | Listar, buscar, criar, atualizar |
| Pipelines | /external/v1/deal-pipelines | Listar, buscar |
| Atividades | /external/v1/activities | Listar, buscar, criar, atualizar |
| Propostas | /external/v1/quotes | Listar, buscar, criar, atualizar |
| Itens de Proposta | /external/v1/quote-items | Listar, buscar, criar, atualizar |
Contratos
| Recurso | Endpoint base | Operacoes |
|---|---|---|
| Contratos Digitais | /external/v1/signs | Listar, buscar, criar, atualizar |
| Contratos Recorrentes | /external/v1/contracts | Listar, buscar, criar, atualizar |
| Itens de Contrato | /external/v1/contract-items | Listar, buscar, criar |
Projetos
| Recurso | Endpoint base | Operacoes |
|---|---|---|
| Projetos | /external/v1/projects | Listar, buscar, criar |
| Waves | /external/v1/project-waves | Listar, buscar, criar, atualizar |
| Epicos | /external/v1/project-epics | Listar, buscar, criar, atualizar |
| Tarefas | /external/v1/project-tasks | Listar, buscar, criar |
| Equipe | /external/v1/project-team-members | Listar, buscar, criar |
Financeiro
| Recurso | Endpoint base | Operacoes |
|---|---|---|
| Lancamentos Financeiros | /external/v1/financial-entries | Listar, buscar, criar |
| Categorias Financeiras | /external/v1/financial-categories | Listar, buscar |
| Contas Bancarias | /external/v1/bank-accounts | Listar, buscar |
| Medicoes | /external/v1/measurements | Listar, buscar, criar |
| Notas Fiscais | /external/v1/invoices | Listar, buscar, criar |
| Cobrancas | /external/v1/charges | Listar, buscar |
| Provisionamento | /external/v1/provisioning | Listar, buscar, criar, atualizar |
Compras
| Recurso | Endpoint base | Operacoes |
|---|---|---|
| Ordens de Compra | /external/v1/purchase-orders | Listar, buscar, criar, atualizar |
| Itens de Ordem | /external/v1/purchase-order-items | Listar, buscar, criar |
RH & Timesheet
| Recurso | Endpoint base | Operacoes |
|---|---|---|
| Perfis de Colaboradores | /external/v1/employee-profiles | Listar, buscar, criar, atualizar |
| Apontamento de Horas | /external/v1/timesheet-entries | Listar, buscar, criar |
| Periodos de Timesheet | /external/v1/timesheet-periods | Listar, buscar, criar |
Help Desk & SLA
| Recurso | Endpoint base | Operacoes |
|---|---|---|
| Tickets | /external/v1/tickets | Listar, buscar, criar, atualizar |
| Comentarios de Ticket | /external/v1/ticket-comments | Listar, buscar, criar |
| Politicas de SLA | /external/v1/sla-policies | Listar, buscar |
Contabilidade
| Recurso | Endpoint base | Operacoes |
|---|---|---|
| Contas Contabeis | /external/v1/accounting-accounts | Listar, buscar |
| Lancamentos Contabeis | /external/v1/accounting-journal-entries | Listar, buscar |
| Partidas Contabeis | /external/v1/accounting-journal-entry-lines | Listar, buscar |
| Relatorios Contabeis | /external/v1/accounting-reports | Balancete, balanco, razao, extrato, dashboard |
Configuracoes & Lookup
| Recurso | Endpoint base | Operacoes |
|---|---|---|
| Centros de Custo | /external/v1/cost-centers | Listar, buscar |
| Unidades de Negocio | /external/v1/business-units | Listar, buscar |
| Campos Customizados | /external/v1/custom-fields | Listar, buscar |
Quick Start — 3 passos
1. Gere sua API Key
Acesse o painel administrativo Tesselys em Configuracoes → Integracoes → API Externa e clique em Gerar nova chave. Voce recebera:
- API Key:
tesselys_ak_...(58 caracteres) - Secret: string base64url (43 caracteres)
cuidado
A API Key e o Secret sao exibidos apenas uma vez. Copie e armazene em local seguro antes de fechar a tela.
2. Autentique-se
curl -X POST https://api.tesselys.com.br/external/v1/auth \
-H "Content-Type: application/json" \
-H "x-api-key: tesselys_ak_abc123..." \
-d '{ "secret": "seu_secret_aqui" }'
Resposta:
{
"accessToken": "eyJhbGciOiJSUzI1NiIs...",
"companyToken": "eyJhbGciOiJIUzI1NiIs...",
"expiresIn": 3600
}
3. Chame um endpoint
curl https://api.tesselys.com.br/external/v1/persons \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiIs..." \
-H "x-company-token: eyJhbGciOiJIUzI1NiIs..."
Pre-requisitos
- Conta ativa no Tesselys com role Owner ou Admin
- Feature API Externa (
DF_EXT_API) habilitada no plano da empresa - Ambiente com acesso HTTPS a
api.tesselys.com.br
Proximos passos
- Autenticacao — detalhes completos do fluxo de auth
- Rate Limits — limites de uso e estrategia de retry
- Codigos de Erro — formato de erros e como trata-los