Visão Geral da Plataforma de Programador

A TrucklineMP oferece uma plataforma de programador para integrações de terceiros. Podes ler dados públicos da plataforma através da Public API, identificar utilizadores 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, usa a referência interativa da API no site principal.

O que podes construir

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

Antes de começares

Cria uma conta TrucklineMP em trucklinemp.com.
Ativa o Modo de Programador em Definições da Conta → Segurança → Modo de Programador → Ativar.
Abre a Consola de Programador a partir da barra de navegação ou das tuas definições de segurança.

O Modo de Programador desbloqueia a consola. Não concede, por si só, permissões elevadas de API. Os endpoints da Public API mantêm-se apenas de leitura. Os âmbitos OAuth controlam a que dados de utilizador a tua aplicação pode aceder depois de um utilizador a autorizar.

Início rápido: Public API

Na Consola de Programador, cria um projeto.
Gera uma chave de API (prefixo tlmp_api_...). Copia-a quando for mostrada. Não pode voltar a ser vista.
Envia um pedido com a tua chave:

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

Experimenta os endpoints de forma interativa no API Playground.

Os endpoints públicos de leitura funcionam sem chave de API. As chaves aumentam os teus limites de taxa e associam a utilização ao teu projeto para análises.

Início rápido: Aplicação OAuth

Na Consola de Programador, vai a Aplicações OAuth e cria uma aplicação.
Define os URIs de redirecionamento e os âmbitos na página de definições OAuth.
Copia a ligação de instalação da visão geral da aplicação (ou constrói o teu próprio URL de autorização).
Enquanto a aplicação não estiver publicada, adiciona utilizadores de teste para que outros a possam autorizar durante o desenvolvimento.
Quando estiver pronta, completa a verificação de domínio e publica através da página de Publicação.

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 ao vivo:

Recurso	URL
OpenAPI JSON	trucklinemp.com/api/v1/openapi.json
Referência interativa	/pt/web-api/public-api/doc (Swagger UI)
Documentação da consola	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`, utilização do cliente, erros, verificação de webhook
OAuth Apps	Fluxo de autorização, âmbitos, userinfo, utilizadores de teste, PKCE, publicação
Webhooks	Subscrições, assinaturas, tentativas de reenvio, catálogo de eventos
Consola de Programador	Projetos, análises, registos de auditoria, quotas, playground
Chaves de API e Segredos Expostos	O que fazer se uma chave ou segredo for exposto publicamente

Privacidade e conformidade

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

As Aplicações OAuth têm de fornecer um URL de política de privacidade e devem fornecer um URL de termos de serviço antes da publicação.