Studytube API
Studytube hat 2 REST-ful APIs verfügbar für die direkte Interaktion mit den Daten, die in der Academy-Provider verfügbar sind.
Diese Dokumentation konzentriert sich darauf, wie man mit der Interaktion mit ihnen beginnt und enthält einige Beispiele, wie dies zu tun ist.
Gesamte API-Dokumentation
Provider API
Verwenden Sie einen API-Client wie Postman, um eine HTTP-Anfrage zu stellen. Die Basis-URL ist abhängig von der Umgebung, auf die Sie zugreifen möchten.
Academy API
Verwenden Sie einen API-Client wie Postman, um eine HTTP-Anfrage zu stellen. Die Basis-URL ist abhängig von der Umgebung, auf die Sie zugreifen möchten.
Title
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse varius enim in ero.
Title
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse varius enim in ero.
Erste Schritte in 3 Schritten
1. Client-Anmeldedaten erhalten
Kontaktieren Sie Ihren Customer Success Manager, um die Client-ID und das Client-Secret für Ihre Academy oder Ihren Provider zu erhalten.
Der Zugriffsbereich jeder Client-ID und jedes Client-Secrets ist 1 spezifische Academy oder 1 spezifischer Provider.
2. Authentifizierung
Die Studytube API verwendet OAuth 2.0 für Authentifizierung und Autorisierung.
Um ein Zugriffstoken anzufordern, verwenden Sie die Client-ID und das Client-Secret, um auf Folgendes zuzugreifen:https://backend.studytube.nl/gateway/oauth/token
Der Standardbereich ist 'read' (nur lesen). Wenn Schreibzugriff erforderlich ist, kann der folgende Bereich angegeben werden: 'read write'.
3. Eine Anfrage senden
Verwenden Sie einen API-Client wie Postman, um eine HTTP-Anfrage zu stellen. Die Basis-URL ist abhängig von der Umgebung, auf die Sie zugreifen möchten:
Basis-URL
-> Academy API: https://public-api.studytube.nl/api/v2/-> Provider API: https://public-api.studytube.nl/provider-api/v2/
Fügen Sie bei jedem API-Aufruf das Bearer-Zugriffstoken im Authorization-Header der Anfrage ein.
Ratenbegrenzung
Die aktuelle Ratenbegrenzung für die API ist auf 120 Anfragen/Minute festgelegt.
Paginierung
Anfragen, die mehrere Elemente zurückgeben, werden auf 25 Elemente standardmäßig paginiert. Sie können weitere Seiten mit dem page-Parameter angeben. Für einige Ressourcen können Sie auch eine benutzerdefinierte Seitengröße von bis zu 1000 mit dem per_page-Parameter festlegen.
Beachten Sie, dass die Seitennummerierung 1-basiert ist und dass das Weglassen des page-Parameters die erste Seite zurückgibt.