Demo aanvragen
    Demo aanvragen

    Studytube API

    Studytube has 2 REST-ful APIs available for directly interacting with the data available in the:
    Academy
    Provider

     This documentation focuses on how to get started with interacting with them and contains some examples of how to do this.

    All API Documentation

    Getting started in 3 steps

    1. Obtaining Client Credentials

    Contact your Customer Success Manager to get the Client ID and Client Secret for your Academy or your Provider.

    The access scope of each Client ID and Client Secret is 1 specific academy, or 1 specific Provider.

    2. Authentication

    The Studytube API uses OAuth 2.0 for authentication and authorization. 

    To request an access token, use the Client ID and Client Secret to access: https://backend.studytube.nl/gateway/oauth/token

    Default scope is 'read' (read-only). If writing access is required, the following scope can be specified. `read write`.

    3. Submit a request

    Use an API client such as Postman to make an HTTP request. The base URL is dependent on the environment you are trying to access:

    Base URL

    For each API call, include the bearer access token in the Authorization header of the request.

    Rate limiting

    Current rate limitation for the API is set at 120 requests/minute.

    Pagination

    Requests that return multiple items will be paginated to 25 items by default. You can specify further pages with the page parameter. For some resources, you can also set a custom page size up to 1000 with the per_page parameter.

    Note that page numbering is 1-based and that omitting the page parameter will return the first page.