SDK-Referenz

Ressourcen und Integrationsleitfäden für Entwickler, die im OikosTV-Ökosystem arbeiten.

API-Übersicht

OikosTV bietet eine robuste Reihe von RESTful-APIs zur Verwaltung von Inhalt, Monetarisierung und Belohnungen. Alle API-Anfragen erfordern eine gültige Authentifizierung über Ihre OikosTV-Sitzung.

Häufige Endpunkte

GET /api/v1/videos/{shortUUID}    // Videodetails abrufen
POST /api/v1/rewards/redeem       // PeerCredits gegen werbefreie Stunden einlösen
GET /api/v1/me/rewards/balance    // Ihr aktuelles Credit-Guthaben überprüfen

Integrationsleitfaden

Verwendung des @crewvid/outpost-sdk

Das SDK vereinfacht die Interaktion mit dem Peer-Netzwerk. Es übernimmt das Abrufen von Fragmenten, die Entschlüsselung (AES-256-GCM) und die Belohnungsverfolgung automatisch.

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

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

client.on('chunkServed', (data) => {
  console.log(`Credits für Fragment verdient: ${data.chunkId}`);
});

Peer-Credits überwachen

Entwickler können Echtzeit-Credit-Guthaben und Einlöseverläufe über die folgenden Endpunkte überwachen, um in ihren eigenen Anwendungen ein nahtloses Erlebnis zu bieten.

Webhooks und Benachrichtigungen

Richten Sie Webhooks ein, um Echtzeit-Benachrichtigungen über Ereignisse auf Ihrem Kanal zu erhalten.

Ereignis	Beschreibung
Upload-Vollendung	Ausgelöst, wenn ein Video die Transkodierung abgeschlossen hat und zur Wiedergabe bereit ist
Neues Trinkgeld erhalten	Echtzeit-Benachrichtigung, wenn ein Zuschauer Ihrem Kanal ein Trinkgeld sendet
Mitgliedschaft beigetreten	Ausgelöst, wann immer ein neuer Benutzer eine Ihrer Mitgliedschaftsstufen beitritt

Webhooks einrichten

1. Navigieren Sie zu Studio → Einstellungen → Webhooks
2. Geben Sie Ihre Endpunkt-URL ein (muss HTTPS sein)
3. Wählen Sie aus, auf welche Ereignisse Sie sich abonnieren möchten
4. Speichern — Sie erhalten sofort eine Test-Nutzlast

Webhook-Sicherheit

Jede Webhook-Nutzlast enthält eine Signatur im X-OikosTV-Signature-Header. Verifizieren Sie diese Signatur vor der Verarbeitung der Nutzlast, um sicherzustellen, dass sie von OikosTV stammt.

---

Brauchen Sie mehr Hilfe?

Schauen Sie sich die API-Übersicht für detaillierte Endpunkt-Dokumentation an oder treten Sie unserer Entwicklercommunity auf GitHub Discussions bei.