Accessing the API

How to create an API client and use it to call the API.

Creating an API Client from the Rightbrain Dashboard

To access the Rightbrain API programmatically, you’ll need to create an API client from your Rightbrain dashboard. API clients use OAuth 2.0 to securely authenticate your requests. Here’s a step-by-step guide:

  1. Log in to your Rightbrain Dashboard: Access the Rightbrain platform through your web browser and log in using your credentials.

  2. Navigate to API Clients: Once logged in, access the API Clients section from the settings menu.

  3. Create a New API Client:

    • Click “Create Client” button
    • Client Name: Enter a descriptive name for your API client (e.g., “My Application Client,” “Server-to-Server Integration”). This name is for your internal reference.
    • Description: Enter a description for your API client.
    • Grant Types: Select the Client Credentials and Refresh Token grant types. Client Credentials is suitable for server-to-server API access where your application authenticates directly using its own credentials. Other grant types like Authorization Code or Implicit might be available for different use cases (e.g., user-authenticated applications).

  4. Save and Retrieve Credentials:

    • After filling in the details, click “Save” to create your API client.
    • Upon successful creation, the dashboard will display your Client Secret - copy this to your clipboard.

    Important Security Note: Treat your Client Secret like a password. Keep it confidential and securely store it. Do not embed it directly in client-side code or commit it to public repositories.

You have now successfully created an API client. Proceed to the next section to learn how to use these credentials to call the API via OAuth 2.0.

Built with