Introduction
Streav API follows the REST principles. API request and response bodies, including errors, are encoded in JSON format.
Streav API uses OAuth 2.0 to provide a secure and standardized way for your applications to obtain access tokens. With OAuth 2.0, your applications can authenticate and access Streav API on behalf of users.
Creating an OAuth Application
To authenticate your applications with Streav API, you need to create an OAuth application.
In Streav dashboard, navigate to the Settings
section and then select OAuth Applications
.
Click New
, and a dialog will appear. Give your application a name and select the appropriate permissions.
Once your OAuth application is created, you will receive client credentials (client ID and client secret) that you will use to authenticate your application.
Authenticating with Streav API
Streav API supports authentication through the client credentials flow. Follow these steps to authenticate your applications with Streav API:
- Use your client credentials (client ID and client secret) obtained from the Streav dashboard to make a POST request
to the
/oauth/token
endpoint. - Include the following parameters in your request:
grant_type
: Set to"client_credentials"
.client_id
: Your OAuth application's client ID.client_secret
: Your OAuth application's client secret.scope
: A space-separated list of scopes for which the access token is requested.
- Upon successful authentication, you will receive an access token in the response.
Scopes
Streav API supports the following scopes to control access to different resources:
api.bundle.read
: Read access to bundles.api.live-stream.read
: Read access to live streams.api.movie.read
: Read access to movies.api.od-stream.read
: Read access to on-demand streams.api.show.read
: Read access to shows.api.subscriber.read
: Read access to subscriber information.api.subscriber.create
: Create access to subscribers.api.subscriber.update
: Update access to subscribers.api.subscriber.delete
: Delete access to subscribers.
When authenticating your applications, you can specify the required scopes to control the level of access.