Benbase

Authentication

Authentication works by sending a registered API Key in all requests.

Authentication

Authentication works by sending a registered API Key in all requests

API Key

Benbase provides API keys to partners, which allow them to authenticate through the API.

Your API key is a long lived token that will be used as a bearer token in request headers.

Requests made to the API should add an Authorization header with this key at all times:

"Authorization": "Bearer {{API_KEY}}"

Key Types

There are two key types:

  1. Sandbox
  2. Production

Sandbox is for integration testing / non-production usage

By convention API keys are prefixed sandbox_sk_ and live_sk_ for Sandbox and Production, respectively

Keys are meant to be secret and should not be shared or visible

API Base URL

The API has separate base URLs for Production and Sandbox modes

  • Sandbox base URL https://embed-sandbox.benbase.com/api
  • Production base URL https://embed.benbase.com/api

All request URLs should begin with the corresponding base URL and send the appropriate key type.