...

Authentication

OAuth2 Bearer

The dRofus API supports two OAuth2 authentication methods:

1. Authorization Code Flow

2. Client Credentials Flow

1. Authorization Code Flow

This method is suitable for web applications where a user needs to grant permission. Registration process of OAuth2 client is currently manual. Please reach out to support@drofus.com for the necessary information and provide your desired redirect_uri(s) and if desired, post_logout_redirect_uri(s).

2. Client Credentials Flow

This method is suitable for server-to-server authentication where no user interaction is required. Contact support@drofus.com to obtain your client_id and client_secret. Use these credentials to request an access token from the token endpoint.

Examples

Python

Postman

Basic HTTP

For testing and simple read-only access, dRofus API supports HTTP Basic Authentication. This method is straightforward to implement but is limited to read access and should not be used in production environments.

1. Generate an API key through the dRofus Power Query interface: https://help.drofus.com/en/English/Learning/power-query#PowerQuery-3.-Credentials%2FLogin .

2. Encode the API key in the format :api_key using Base64

3. Include the encoded string in the Authorization header

Bearer

API generally supports OAauth2 standard Bearer tokens. Registration process of OAuth2 client is currently manual, please reach out to support@drofus.com and we can provide needed information. Please send us the desired redirect_uri(s) (and if desired, post_logout_redirect_uri(s)).

For testing purpose, HTTP Basic authentication can also be used. However, it should be avoided for production applications. 

API-key

API supports reading data using "API-key". This access mode intended to be used by a person for reading ad-hoc data and/or recurring API-calls such as dashboards, PowerQuery (Excel, PoweBI), etc.

...

<http://localhost/api/database/01/rooms?$skip=1&$top=1>; rel=\"next\">

Examples

Examples of how to use the API:

...