Référence du SDK

Ressources et guides d'intégration pour les développeurs construisant sur l'écosystème OikosTV.

Aperçu de l'API

OikosTV fournit un ensemble robuste d'APIs RESTful pour gérer le contenu, la monétisation et les récompenses. Toutes les requêtes API nécessitent une authentification valide via votre session OikosTV.

Endpoints courants

GET /api/v1/videos/{shortUUID}    // Récupérer les détails de la vidéo
POST /api/v1/rewards/redeem       // Échanger des PeerCredits contre des heures sans publicité
GET /api/v1/me/rewards/balance    // Consulter votre solde actuel de crédits

Guide d'Intégration

Utiliser le @crewvid/outpost-sdk

Le SDK simplifie l'interaction avec le réseau peer. Il gère la récupération des fragments, le déchiffrement (AES-256-GCM) et le suivi des récompenses automatiquement.

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

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

client.on('chunkServed', (data) => {
  console.log(`Crédits gagnés pour le fragment : ${data.chunkId}`);
});

Surveillance des Peer Credits

Les développeurs peuvent surveiller les soldes de crédits en temps réel et l'historique d'échange via les endpoints suivants pour fournir une expérience fluide dans leurs propres applications.

Webhooks et Notifications

Configurez des webhooks pour recevoir des notifications en temps réel sur les événements de votre chaîne.

Événement	Description
Fin de Téléchargement	Déclenché lorsqu'une vidéo a terminé le transcodage et est prête pour la lecture
Nouveau Pourboire Reçu	Notification en temps réel lorsqu'un spectateur envoie un pourboire à votre chaîne
Adhésion à un Abonnement	Déclenché chaque fois qu'un nouvel utilisateur rejoint l'un de vos niveaux d'abonnement

Configurer les webhooks

1. Accédez à Studio → Paramètres → Webhooks
2. Entrez votre URL d'endpoint (doit être HTTPS)
3. Sélectionnez les événements auxquels vous abonner
4. Enregistrez — vous recevrez une charge de test immédiatement

Sécurité des webhooks

Chaque charge du webhook inclut une signature dans l'en-tête X-OikosTV-Signature. Vérifiez cette signature avant de traiter la charge pour vous assurer qu'elle provient de OikosTV.

---

Besoin d'aide ?

Consultez l'Aperçu de l'API pour une documentation détaillée des endpoints, ou rejoignez notre communauté de développeurs sur GitHub Discussions.