Skip to main content

API Keys

  1. Obtain your production and test API keys from your JOFI representative. Your production key will be prefixed with sk_live. Your test key will be prefixed with sk_test.
  2. Include your API key in the headers of your requests, as an Authentication Bearer token (i.e. { Authentication: "Bearer sk_live_ELAbCDEfHijKl" }).
  3. Use the test API key for dev and QA testing.
  4. Warning: Do not commit your API key to your code repository or share it publicly, it should be considered a highly sensitive secret as it can be used to create and read participant data.

Every API response will include a mode property. mode: "live" indicates you are using a production key, and real resources will be created. mode: "test" indicates you are using a test key, so fake responses will be returned.

tip

Use your test API key (prefixed with sk_test) during development. It will respond as if you made a successful request, returning a properly formed (fake) object for invitations or test takers, but no actual records will be created in the JOFI database.