Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction to dRofus API Authentication

To interact with the dRofus API, you need to authenticate using OAuth2 Bearer tokens. The dRofus API supports two OAuth2 authentication methods:

1. Authorization Code Flow

This method is designed for web applications where a user needs to actively grant permission. It's typically used when user interaction is required to approve access (eg selecting db and project)

2. Client Credentials Flow

This flow is more suited for server-to-server communication, where no user interaction is needed. It allows your backend systems to communicate with the dRofus API autonomously.

In the guides below, we will use the Client Credentials Flow as it's best for automated, script-based, or backend API interactions. Balazs will provide you with your client_id and client_secret.

Authorization for Writing Data

For write operations (updating or creating data), make sure that a user named "test" is included in the dRofus project. All modifications will be made under this user account, which should have the necessary permissions.

Examples

Simple dRofus Read/Write API in Python

...