Content APIs
Quran.Foundation Content APIs offer programmatic access to the Quran's core content like chapters, verses, recitations, translations, and more, distinct from user-specific data like notes and bookmarks provided by User-related APIs.
How to get access
We are using OAuth2 flows to authenticate and authorize requests. To get started, you need to get an access token to make requests to our APIs. Since the APIs are not user-related, you will need to use the client_credentials grant type and content scope to get the access token. The below diagram shows the flow of getting an access token using the client_credentials grant type in a very simplified way.
After getting a valid access token, each request to get resources will have to include 2 headers mentioned below: x-auth-token and x-client-id.
Authentication
The JWT access token required for accessing the endpoints.
| Security Scheme Type: | apiKey |
|---|---|
| Header parameter name: | x-auth-token |
Your client Id
| Security Scheme Type: | apiKey |
|---|---|
| Header parameter name: | x-client-id |