Desenvolvedores
Documentação, cabeçalhos e descoberta da API do desenvolvedor
A API externa, o fluxo de trabalho da chave de API, o transporte MCP e os arquivos de descoberta legíveis por máquina são documentados aqui com os caminhos ativos usados pelo produto.
Chaves de API
Crie e revogue chaves em Painel > Configurações > Chaves de API ou use as rotas de gerenciamento conectadas.
Somente Professional e Enterprise.
API REST
Call https://tubeanalytics.net/api/external/v1 with Bearer auth.
Respostas JSON com erros estruturados.
Transporte MCP
Connect agents to https://tubeanalytics.net/api/mcp or use npm run mcp:stdio.
Suporte para HTTP e stdio streamable.
Arquivos de descoberta
Use /openapi.json, /mcp.json, /ai-pricing.json, and /ai.txt as the machine-readable source of truth.
Sempre atualizado com as rotas ao vivo.
Início rápido
Experimente um endpoint ativo. Substitua channel_id e YOUR_API_KEY por valores reais:
curl -X GET "https://tubeanalytics.net/api/external/v1/analytics?channel_id=<channel_id>&range=28d" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Accept: application/json"JavaScript
const res = await fetch("https://tubeanalytics.net/api/external/v1/analytics?channel_id=<id>&range=28d", {
headers: { Authorization: "Bearer <api_key>" }
});
const data = await res.json();Python
import httpx
res = httpx.get(
f"{apiBase}/analytics",
params={"channel_id": "<id>", "range": "28d"},
headers={"Authorization": "Bearer <api_key>"}
)
data = res.json()channel_id accepts either the TubeAnalytics channel ID or the YouTube channel ID. The same Bearer key works for every external endpoint below. API access requires a Professional or Enterprise plan.Como conectar
Conecte um canal do YouTube no painel
Os dados externos da API vêm de canais conectados. Faça login, conecte um canal e aguarde a conclusão da sincronização inicial antes de fazer chamadas de servidor para servidor.
Crie uma chave de API
Abra Dashboard > Configurações > Chaves de API em uma conta Professional ou Enterprise ou chame POST /api/v1/keys de uma sessão autenticada.
Enviar solicitações autenticadas pelo portador
Use Authorization: Bearer <api_key> em cada solicitação externa. Mantenha as chaves do lado do servidor e não as incorpore no código do cliente.
Use arquivos de descoberta para ferramentas e agentes
Extraia a especificação OpenAPI, o manifesto MCP, o manifesto de preços ai e o arquivo ai.txt ao gerar clientes, conectar agentes ou validar integrações.
Pontos de extremidade de referência
Parâmetros de consulta
A maioria dos endpoints externos da API aceita parâmetros de consulta comuns para filtragem, paginação e classificação. O esquema completo por endpoint está na especificação OpenAPI.
channel_idrangelimitoffsetsortAutenticação e cabeçalhos
As solicitações externas usam o esquema de chave Bearer API no cabeçalho Authorization. Mantenha a chave do lado do servidor. Crie e gire chaves em Painel > Configurações > Chaves de API ou nas rotas de gerenciamento conectadas.
- Authorization
- Bearer <api_key>
- Accept
- application/json
- Content-Type
- application/json
- Rate-limit headers
- X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
- Retry header
- Retry-After on 429 responses
Rotas de gerenciamento conectadas
Essas rotas são para sessões de painel autenticadas, não para clientes de API de servidor para servidor:
GET /api/v1/keyslistar chaves de APIPOST /api/v1/keyscrie uma nova chave de APIDELETE /api/v1/keys/:keyIdrevogar uma chaveGET /api/v1/users/profile and related dashboard session routespermanecer separado
Acesso e limites
A superfície de preços anuncia permissões mensais de chamadas de API por plano, enquanto a API externa ativa impõe um limite de solicitação de janela deslizante e retorna cabeçalhos de limite de taxa em cada resposta. Lembre-se de ambos ao criar novas tentativas de cliente e painéis de cota.
Na implementação atual, a API externa retorna X-RateLimit-Limit, X-RateLimit-Remaining e X-RateLimit-Reset em respostas bem-sucedidas, além de Retry-After quando uma solicitação é limitada.
Formato de erro
As rotas externas da API retornam erros JSON estruturados com error.code e error.message. Use o código para ramificar o tratamento de erros e a mensagem para logs legíveis por humanos.
{
"error": {
"code": "BAD_REQUEST",
"message": "channel_id query parameter is required"
}
}Status comuns
- 400 Parâmetros de solicitação ausentes ou inválidos
- 401 Chave de API ausente ou inválida
- 403 Chave de API válida, mas o plano não é elegível
- 404 Canal ou recurso conectado não encontrado
- 429 Limite de taxa excedido
- 500 Erro inesperado do servidor
Pronto para construir?
Inscreva-se em um plano Professional ou Enterprise para obter acesso à API. Já tem uma conta? Vá para o painel para criar chaves de API.