Skip to content

Visão Geral da API

Uma visão geral de alto nível dos endpoints públicos da API do OikosTV.

URL Base

https://dev.api.crewvid.com/api/v1/

Conteúdo e Descoberta

MétodoEndpointDescrição
GET/videos/{shortUUID}Obter informações detalhadas sobre um vídeo específico
GET/channels/{handle}Obter detalhes do canal, incluindo contagem de inscritos e metadados
GET/videos/{shortUUID}/playbackObter pacote de reprodução (manifest + session JWT) para um vídeo

Monetização e Recompensas

MétodoEndpointDescrição
GET/me/rewards/balanceVerificar seu saldo atual de PeerCredits
POST/rewards/redeemTrocar PeerCredits por horas de visualização sem anúncios
GET/studio/monetization/flagsVer recursos de monetização habilitados para um canal

Autenticação

Todas as solicitações à API devem incluir um token de sessão válido no cabeçalho Authorization:

http
Authorization: Bearer <session_token>

Limitação de taxa

Para garantir a estabilidade da plataforma, todos os endpoints públicos estão sujeitos à limitação de taxa. Por favor, implemente backoff exponencial para tentativas.

Versionamento

Usamos URLs versionadas (ex.: /api/v1/...) para manter compatibilidade retroativa conforme a API evolui. A versão estável atual é v1.

Respostas de Erro

A API retorna erros em um formato consistente:

json
{
  "error": "Descrição do que deu errado"
}

Códigos de status HTTP comuns:

CódigoSignificado
400Solicitação Inválida — parâmetros inválidos
401Não Autorizado — token ausente ou inválido
403Proibido — permissões insuficientes
404Não Encontrado — recurso não existe
429Muitas Solicitações — limite de taxa excedido
500Erro Interno do Servidor

SDK disponível

Para integração mais fácil, use o pacote @crewvid/outpost-sdk em vez de chamar a API diretamente.