Referencia del SDK

Recursos y guías de integración para desarrolladores que construyen sobre el ecosistema OikosTV.

Resumen de la API

OikosTV proporciona un conjunto robusto de APIs RESTful para gestionar contenido, monetización y recompensas. Todas las solicitudes a la API requieren autenticación válida a través de tu sesión OikosTV.

Endpoints comunes

GET /api/v1/videos/{shortUUID}    // Obtener detalles del video
POST /api/v1/rewards/redeem       // Canjear PeerCredits por horas sin anuncios
GET /api/v1/me/rewards/balance    // Consultar tu saldo actual de créditos

Guía de Integración

Usando el @crewvid/outpost-sdk

El SDK simplifica la interacción con la red peer. Maneja la obtención de fragmentos, descifrado (AES-256-GCM) y seguimiento de recompensas automáticamente.

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 ganados por fragmento: ${data.chunkId}`);
});

Monitoreo de Peer Credits

Los desarrolladores pueden monitorear saldos de créditos en tiempo real e historial de canjes a través de los siguientes endpoints para proporcionar una experiencia fluida en sus propias aplicaciones.

Webhooks y Notificaciones

Configura webhooks para recibir notificaciones en tiempo real sobre eventos en tu canal.

Evento	Descripción
Completado de Subida	Disparado cuando un video ha terminado de transcodificarse y está listo para reproducción
Nueva Propina Recibida	Notificación en tiempo real cuando un espectador envía una propina a tu canal
Membresía Unida	Disparado cada vez que un nuevo usuario se une a uno de tus niveles de membresía

Configurando webhooks

1. Navega a Estudio → Configuración → Webhooks
2. Ingresa tu URL de endpoint (debe ser HTTPS)
3. Selecciona a qué eventos suscribirte
4. Guarda — recibirás una carga de prueba inmediatamente

Seguridad de webhooks

Cada carga del webhook incluye una firma en el encabezado X-OikosTV-Signature. Verifica esta firma antes de procesar la carga para asegurar que proviene de OikosTV.

---

¿Necesitas más ayuda?

Consulta el Resumen de la API para documentación detallada de endpoints, o únete a nuestra comunidad de desarrolladores en GitHub Discussions.