Zum Hauptinhalt springen

Wie nutze ich die Youtilly-API?

Die Youtilly-API ermöglicht Ihnen, spezifische Informationen aus Youtilly über eine standardisierte Schnittstelle abzurufen bzw. Aktionen auszuführen.

Aufruf der API

Die Youtilly-API steht unter https://api.youtilly.de bereit. Die API nutzt das HTTP(S)-Protokoll, folgt dem REST-Prinzip und nutzt JSON-Serialisierung zum Datenaustausch.

Dokumentation verfügbarer Endpunkte

Alle verfügbaren Endpunkte sind in einer interaktiven Dokumentation unter https://api.youtilly.de dokumentiert. Hier steht auch eine maschinenlesbare Dokumentation im OpenAPI-Standard zum Download bereit.

Weitere Endpunkte stehen aktuell nicht zur Verfügung. Haben Sie Bedarf an zusätzlichen Endpunkten, dann kontaktieren Sie uns gerne.

Versionierung

Die Youtilly-API ist versioniert. Die genutzte Version befindet sich im Pfad des aufgerufenen Endpunkts. Jede Version ist separat dokumentiert. Eine Versionsauswahl ist in der interaktiven Dokumentation möglich.

Nicht abwärtskompatible Änderungen (bspw. Änderungen an Datentypen, Entfernung von Endpunkten) resultieren in einer neuen API-Version. Sonstige Änderungen können innerhalb einer bestehenden API-Version erfolgen.

Erscheint eine neue API-Version, so bleibt die vorherige API-Version für eine Übergangszeit verfügbar. Kontaktieren Sie uns, um bei Änderungen an der API informiert zu bleiben. Wir nehmen Sie gerne auf einen entsprechenden Verteiler auf.

Während der Entwicklung einer neuen API-Version kann diese bereits als Beta bereitgestellt werden. Während der Beta-Entwicklungszeit sind beliebige Änderungen an der API möglich und zu erwarten.

Aktuell verfügbare Versionen:

  • v1-beta

Nutzung der API

Gehen Sie wie folgt vor, um die Youtilly-API zu nutzen:

  1. Stellen Sie sicher, dass Ihr Nutzer:innen-Konto auf Youtilly über die Berechtigung Öffentliche API nutzen verfügt.

  2. Öffnen Sie in Youtilly die Seite Einstellungen > Persönliche Einstellungen > Sicherheit.

  3. Notieren Sie sich die in der Karte API-Schlüssel angezeigte User-ID.

  4. Erstellen Sie einen API-Schlüssel und notieren Sie diesen.

  5. Nutzen Sie den Endpunkt auth/createSession, um eine API-Sitzung zu starten. Hierfür benötigen sie die zuvor notierte User-ID und API-Schlüssel. Der Endpunkt sendet im Gegenzug einen Session Token, der für 24 Stunden gültig ist.

  6. Nutzen Sie nun beliebige Endpunkte, um Daten abzurufen oder Aktionen auszuführen. Senden Sie den erhaltenen Session Token im Authorization Header im Bearer-Schema.

Datentypen

Beachten Sie folgende Hinweise zu den genutzten Datentypen:

  • Daten ohne Uhrzeit werden als Millisekunden-Timestamp in UTC angegeben. Bspw. 01.01.2000 = 946681200000.

  • Daten mit Uhrzeit werden als Millisekunden-Timestamp in UTC angegeben. Bspw. 01.01.2000 00:00:00 UTC = 946681200000.

Hat dies Ihre Frage beantwortet?