Pular para o conteúdo principal

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ísticaDetalhe
ProtocoloREST sobre HTTPS
FormatoJSON (requisição e resposta), UTF-8
VersãoNo caminho: /external/v1
AutenticaçãoAPI Key + Secret trocados por tokens (veja Autenticação)
EscopoUma chave por empresa; tudo o que a chave lê e grava é da empresa dona dela
LimitesVeja Rate limits
DisponibilidadeGET /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​

RecursoRota baseOperações
Pessoas/personsListar, buscar, criar, atualizar
E-mails da pessoa/person-emailsListar, buscar, criar, atualizar
Telefones da pessoa/person-phonesListar, buscar, criar, atualizar
Produtos/productsListar, buscar, criar, atualizar

CRM e vendas​

RecursoRota baseOperações
Leads/leadsListar, buscar, criar, atualizar
Negócios/dealsListar, buscar, criar, atualizar
Itens do negócio/deal-itemsListar, buscar, criar, atualizar
Pipelines/deal-pipelinesListar, buscar
Atividades/activitiesListar, buscar, criar, atualizar
Propostas/quotesListar, buscar, criar, atualizar
Itens da proposta/quote-itemsListar, buscar, criar, atualizar

Contratos​

RecursoRota baseOperações
Documentos para assinatura/signsListar, buscar, criar, atualizar
Contratos recorrentes/contractsListar, buscar, criar, atualizar
Itens do contrato/contract-itemsListar, buscar, criar

Projetos​

RecursoRota baseOperações
Projetos/projectsListar, buscar, criar
Waves/project-wavesListar, buscar, criar, atualizar
Épicos/project-epicsListar, buscar, criar, atualizar
Tarefas/project-tasksListar, buscar, criar
Equipe do projeto/project-team-membersListar, buscar, incluir ou mudar papel

Financeiro​

RecursoRota baseOperações
Lançamentos financeiros/financial-entriesListar, buscar, criar
Categorias financeiras/financial-categoriesListar, buscar
Contas bancárias/bank-accountsListar, buscar
Medições/measurementsListar, buscar, criar
Notas fiscais/invoicesListar, buscar, criar
Cobranças/chargesListar, buscar
Provisionamentos/provisioningListar, buscar, criar, atualizar

Compras​

RecursoRota baseOperações
Pedidos de compra/purchase-ordersListar, buscar, criar, atualizar
Itens do pedido de compra/purchase-order-itemsListar, buscar, criar

RH e timesheet​

RecursoRota baseOperações
Perfis de colaboradores/employee-profilesListar, buscar, criar, atualizar
Apontamentos de horas/timesheet-entriesListar, buscar, criar
Períodos de timesheet/timesheet-periodsListar, buscar, criar

Help desk e SLA​

RecursoRota baseOperações
Chamados/ticketsListar, buscar, criar, atualizar
Comentários do chamado/ticket-commentsListar, buscar, criar
Políticas de SLA/sla-policiesListar, buscar

Contabilidade​

RecursoRota baseOperações
Contas contábeis/accounting-accountsListar, buscar
Lançamentos contábeis/accounting-journal-entriesListar, buscar
Partidas/accounting-journal-entry-linesListar, buscar
Relatórios contábeis/accounting-reports/...Balancete, balanço, razão, extrato, resumo

Configurações e consulta​

RecursoRota baseOperações
Centros de custo/cost-centersListar, buscar
Unidades de negócio/business-unitsListar, buscar
Campos customizados/custom-fieldsListar, buscar

Plataformas parceiras​

RecursoRota baseOperações
Aperto de mão/integrations/:provider/connectConectar, desconectar
Pedidos de contratação/hiring-requestsReceber 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.
Exibição única

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​

Ainda com dúvida?

A nossa equipe ajuda você a configurar e usar esse recurso.