Before diving into the API, ensure you have the following prerequisites:
dScribe Account: A registered dScribe account is required to access the API.
API Key: Obtain an API key through your dScribe account for authentication.
Familiarity with RESTful Principles: Basic knowledge of RESTful conventions and HTTP methods (GET, POST, PUT, DELETE) is recommended.
As an API user, you have two ways to authenticate with our API endpoints:
API keys
OAuth Clients
Creating an API key
You can obtain an API key by navigating here. You need owner priviliges for your organisation, you will not see the page if you don't.
Create a key and select the necessary scopes. You have fine-grained control over what the API key can access and what it cannot access.
Use the API key in the x-dscribe-api-key header in your API calls.
Creating an OAuth Client
After you created a client, you will see your client_id and client_secret. This will only be shown once, store it somewhere safe.
You can create an OAuth Client here. You need owner priviliges for your organisation, you will not see the page if you don't.
After you create a client, copy the secret and id.
This client_id and client_secret can now be exchanged for an access_token to make authenticated requests.
POST /catalog/api/api-token
To get a JWT token you can send a POST request to https://__tenant__.dscribe.cloud/catalog/api/api-token.
The body should be url encoded and contain the following information:
Key | Value |
| <client_id> |
| <client_secret> |
| client_credentials |
| default |
A succesful response should contain the access token to make authenticated requests:
{
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI....",
}
This token will be valid for 15 days. Add it as a Bearer token to the Authorization header.
Authorization: Bearer yholmghj8§hbfg...
Make your first request
With the access_token, you can now perform any request supported by our API. The documentation can be found in the same place you created your API key or OAuth client. Click on the documentation tab to get started.
