Referência do SDK

Recursos e guias de integração para desenvolvedores construindo no ecossistema OikosTV.

Visão Geral da API

O OikosTV fornece um conjunto robusto de APIs RESTful para gerenciar conteúdo, monetização e recompensas. Todas as solicitações à API requerem autenticação válida através da sua sessão OikosTV.

Endpoints comuns

GET /api/v1/videos/{shortUUID}    // Obter detalhes do vídeo
POST /api/v1/rewards/redeem       // Trocar PeerCredits por horas sem anúncios
GET /api/v1/me/rewards/balance    // Verificar seu saldo atual de créditos

Guia de Integração

Usando o @crewvid/outpost-sdk

O SDK simplifica a interação com a rede peer. Ele gerencia a busca de fragmentos, descriptografia (AES-256-GCM) e rastreamento de recompensas automaticamente.

import { CrewOutpostClient } from '@crewvid/outpost-sdk';

const client = new CrewOutpostClient({
  apiKey: 'your_api_key',
  storageQuota: 50, // GB
});

client.on('chunkServed', (data) => {
  console.log(`Créditos ganhos por fragmento: ${data.chunkId}`);
});

Monitoramento de Peer Credits

Os desenvolvedores podem monitorar saldos de créditos em tempo real e histórico de trocas através dos seguintes endpoints para fornecer uma experiência fluida em seus próprios aplicativos.

Webhooks e Notificações

Configure webhooks para receber notificações em tempo real sobre eventos no seu canal.

Evento	Descrição
Conclusão de Upload	Disparado quando um vídeo terminou a transcodificação e está pronto para reprodução
Nova Gorjeta Recebida	Notificação em tempo real quando um espectador envia uma gorjeta ao seu canal
Membro Adesão	Disparado sempre que um novo usuário entra em um dos seus níveis de membro

Configurando webhooks

1. Navegue até Studio → Configurações → Webhooks
2. Insira sua URL de endpoint (deve ser HTTPS)
3. Selecione a quais eventos se inscrever
4. Salve — você receberá uma carga de teste imediatamente

Segurança de webhooks

Cada carga do webhook inclui uma assinatura no cabeçalho X-OikosTV-Signature. Verifique esta assinatura antes de processar a carga para garantir que é do OikosTV.

---

Precisa de mais ajuda?

Consulte a Visão Geral da API para documentação detalhada dos endpoints, ou junte-se à nossa comunidade de desenvolvedores no GitHub Discussions.