Pular para o conteúdo

Com a API do Tinko você pode integrar sua aplicação à plataforma de atendimento de forma programática: automatizar o envio de mensagens, gerenciar contatos, monitorar conversas, configurar webhooks para receber eventos em tempo real e muito mais.

Nos comunicamos via HTTP REST e retornamos as respostas em JSON. A autenticação é por Bearer Token, que você obtém nas configurações da sua conta.

URL base

https://api.tinko.com.br/v1

Chame todos os endpoints a partir dessa URL base. Use HTTPS e inclua o header Authorization: Bearer <seu-token> em todas as requisições.

Por onde começar?

Autenticação

Saiba como gerar e utilizar seu token de acesso para autenticar as chamadas à API.

Ver Autenticação →

Status & Erros

Entenda os códigos de status HTTP, formatos de resposta e como tratar erros.

Ver Status da API →

Limites de Requisições

Conheça os rate limits por endpoint e como evitar bloqueios.

Ver Limites →

Webhooks

Receba notificações em tempo real para mensagens, chats e outros eventos.

Ver Webhooks →

Padrões da API

Autenticação

Exigimos um Bearer Token no header Authorization em todas as requisições:

Authorization: Bearer <seu-token>

Você gera o token nas configurações da sua conta Tinko. Veja Autenticação para mais detalhes.

Formato das Respostas

Nossas respostas são em JSON. Em sucesso, enviamos os dados no corpo. Em erro, retornamos um objeto com message descrevendo o problema.

Paginação

Nos endpoints de listagem, retornamos um objeto pagination com os campos:

CampoDescrição
totalTotal de registros encontrados
per_pageQuantidade de itens por página
current_pagePágina atual
last_pageÚltima página disponível

Rate Limit

Aplicamos limites por endpoint. Veja Limites de Requisições para os detalhes de cada recurso.

Referência de Endpoints

Recursos Principais

RecursoDescrição
CanaisListe os canais de comunicação disponíveis (WhatsApp, Instagram, etc.)
ChatsGerencie conversas, transfira entre atendentes e canais
MensagensEnvie mensagens e consulte histórico de conversas
ContatosCrie e gerencie contatos, campos personalizados e notas
TagsOrganize contatos e chats com etiquetas
UsuáriosGerencie usuários e permissões da equipe
TemplatesVeja templates de mensagens pré-aprovados

Webhooks

TópicoDescrição
ConfiguraçãoComo configurar a URL de destino dos eventos
Eventos SuportadosLista completa de eventos disponíveis
Práticas RecomendadasSegurança, idempotência e tratamento de falhas

MCP (Model Context Protocol)

TópicoDescrição
IntroduçãoO que é o MCP e como ele se integra ao Tinko
ConfiguraçãoComo conectar agentes de IA à API via MCP
Ferramentas DisponíveisLista de ferramentas expostas pelo servidor MCP

Suporte

Se tiver problema ou dúvida, confira nossa página de contato ou o FAQ com as perguntas mais comuns.