Skip to content

API credentials

The Partner API is a REST API with various endpoints that return JSON data about all kinds of resources related to the Jifeline dashboard used by RSS companies. For more in-depth information, consult our background information on this matter.

What do you need

There are two scenarios. If either you or somebody else has already generated the API credentials for openOBD, we advise you to use these credentials, as there is currently a maximum limit of 5 API credentials that can be generated. If there are no API credentials available yet, you need to generate those credentials. The following procedure will guide you through this process.

Environment variables

In our examples on this website we mainly make use of our Python client implementation of openOBD. The Python package that we publish retrieves its credentials from environment variables. It is convenient to define the required environment variables in one file. We will name this file openobd_credentials.env, but you can pick any name of your preference. It is important to keep this file on a safe location .

The template for openobd_credentials.env looks like this.

OPENOBD_PARTNER_CLIENT_ID=<Client ID>
OPENOBD_PARTNER_CLIENT_SECRET=<Client Secret>
OPENOBD_CLUSTER_ID=001
OPENOBD_GRPC_HOST=grpc.openobd.com

OPENOBD_PARTNER_CLIENT_ID
Client ID is unique identifier for the credential set

OPENOBD_PARTNER_CLIENT_SECRET
Client secret contains the value that is used for authentication

OPENOBD_CLUSTER_ID
The cluster id where the openOBD sessions should run (001 = production europe, 002 = production usa)

OPENOBD_GRPC_HOST
The gRPC host contains the address where the openOBD client should connect to. This will always be grpc.openobd.com

You need to fill out the <Client ID> and <Client Secret> in the file shown above with the right values. The values for OPENOBD_CLUSTER_ID and OPENOBD_GRPC_HOST are always the same.

Generate API credentials

We will explain in the following steps how the <Client ID> and <Client Secret> can be retrieved.

Log into your Jifeline Partner Dashboard
Go to your API credentials page
  • Go to the Settings page

Settings

  • Click on the API tab

API Settings
API settings

  • Click on 'Manage your API credentials'
Add new API credentials

Add new API credentials

  • Click on 'Add new API credentials'

Generate credentials
Generate credentials

  • Choose a proper name for your credentials, like 'openOBD'
  • Select 'General credential set' as your credential type
  • Click 'Generate' and the credentials will be mailed to the e-mail address that is registered with your account


API credentials
API credentials

  • Your newly generated credentials will appear in the list of API credentials

<Client Id>
<Client Secret>

When you have added the new API credentials, you will receive an e-mail containing the Client ID and the Client Secret. You can use these values and fill them out in your environment variables file.

OPENOBD_PARTNER_CLIENT_ID=<Client ID>
OPENOBD_PARTNER_CLIENT_SECRET=<Client Secret>

  Make sure that you save this file in a secure location. Protect these credentials properly.

Continue to the next step: Development environment