Skip to content

Client Authentication

twistedstream edited this page Oct 17, 2014 · 2 revisions

NOTE: Client Authentication is currently not enabled, but is coming soon

The API requires the use of an API key in order to access most of its resources. The key helps those that operate the hosted version of the API to monitor usage. As a developer of an app that uses the API, you will need to obtain your own API key and pass it with each request you make to the API.

Obtaining Your API Key

To obtain your own API key, submit a request to the RadBus team via the API Key Request Form. Once your request is processed, you'll get your key sent to you via the email address you provide in the form.

Using Your API Key

Once you have an API key, you pass it to an API request via the API-Key HTTP request header:

GET https://api.radbus.io/v1/routes
API-Key: your-api-key-here

Client Authentication Failure Responses

Any endpoint that requires client authentication can produce the following errors:

401 Unauthorized

  • No API-Key request header was passed.
  • An invalid API key was passed