Visão Geral da Plataforma para Desenvolvedores

O TrucklineMP oferece uma plataforma de desenvolvedor para integrações de terceiros. Você pode ler dados públicos da plataforma através da Public API, identificar usuários com OAuth 2.0, e receber atualizações em tempo real através de webhooks.

Esta documentação cobre conceitos e fluxos de trabalho. Para a lista completa de endpoints, formatos de pedido e esquemas de resposta, use a referência interativa da API no site principal.

O que pode construir

Integração	Ideal para
Public API	Bots, dashboards, sites de estatísticas e ferramentas que leem VTCs, eventos, notícias, usuários e dados de moderação
Aplicativos OAuth	Aplicações que autenticam usuários com a sua conta do TrucklineMP e leem dados de perfil com escopo limitado
Webhooks	Serviços que reagem a eventos da plataforma (adesões de membros, banimentos, RSVPs, e mais)

Antes de começar

1. Crie uma conta do TrucklineMP em trucklinemp.com.
2. Ative o Modo de Desenvolvedor em Configurações da Conta → Segurança → Modo de Desenvolvedor → Ativar.
3. Abra o Console do Desenvolvedor a partir da barra de navegação ou das suas configurações de segurança.

O Modo de Desenvolvedor libera o acesso ao console. Não concede, por si só, permissões elevadas de API. Os endpoints da Public API continuam sendo somente leitura. Os escopos OAuth controlam a que dados de usuário a sua aplicação pode acessar depois que um usuário concede autorização.

Início rápido: Public API

1. No Console do Desenvolvedor, crie um projeto.
2. Gera uma chave de API (prefixo tlmp_api_...). Copie-a quando for mostrada. Não pode voltar a ser vista.
3. Envia um pedido com a sua chave:

curl -H "Authorization: Bearer tlmp_api_YOUR_API_KEY" \
  "https://api.trucklinemp.com/vtcs"

4. Experimenta os endpoints de forma interativa no API Playground.

Os endpoints públicos de leitura funcionam sem chave de API. As chaves aumentam seus limites de taxa e associam a uso ao seu projeto para análises.

Início rápido: Aplicativo OAuth

1. No Console do Desenvolvedor, acesse OAuth Apps e crie uma aplicação.
2. Defina os redirect URIs e os scopes na página de configurações OAuth.
3. Copie a conexão de instalação da visão geral da aplicação (ou constrói o seu próprio URL de autorização).
4. Enquanto o aplicativo não estiver publicado, adicione usuários de teste para que outros usuários possam autorizá-lo durante o desenvolvimento.
5. Quando estiver pronto, conclua a verificação de domínio e publique pela página Publishing.

Ver OAuth Apps para o fluxo de autorização completo, PKCE e regras de publicação.

Onde encontrar a referência da API

A referência canónica de endpoints é gerada a partir da especificação OpenAPI em tempo real:

Recurso	URL
OpenAPI JSON	trucklinemp.com/api/v1/openapi.json
Referência interativa	/pt-br/web-api/public-api/doc (Swagger UI)
Documentação do console	trucklinemp.com/developer/docs
Playground	trucklinemp.com/developer/playground

Mapa da documentação

Guia	Tópicos
Public API	Autenticação, URLs base, limites de taxa, visão geral dos endpoints
TypeScript SDK	Instalar @trucklinemp/sdk, uso do cliente, erros, verificação de webhook
OAuth Apps	Fluxo de autorização, âmbitos, userinfo, usuários de teste, PKCE, publicação
Webhooks	Assinaturas, assinaturas, tentativas de reenvio, catálogo de eventos
Console do Desenvolvedor	Projetos, análises, registros de auditoria, cotas, playground
Chaves de API e Segredos Expostos	O que fazer se uma chave ou segredo for exposto publicamente

Privacidade e conformidade

A uso da API é registrada para limitação de taxa, prevenção de abuso e análises. Ver a Política de Privacidade para saber como a telemetria é tratada.

Os aplicativos OAuth precisam fornecer um URL de política de privacidade e um URL de termos de serviço antes da publicação.