Sections

Authentication overview

Adhering to standards and enforcing security are key business considerations for you and for Beeline. Beeline APIs authentication requirements meet Internet Engineering Task Force (IETF) standards. The IETF is a world-recognized open standards organization.

OAuth (open-standard authorization) 2.0 protocol with client credentials using Auth0 is required for most APIs. The OAuth 2.0 framework is an industry-standard for authorizing designated secure access to APIs. Auth0 provides a robust authentication framework.

Prerequisites

Before you leverage the power of Beeline APIs, you need to complete these steps:

  1. Request access and register with Beeline using the form on the Request Access page.
  2. Obtain authorization to access your organization's Beeline extended workforce platform data. You'll receive an confirmation email from Beeline with details.

Making a call to a Beeline API

After you're registered with and have been authenticated and authorized by Beeline, follow these steps to start calling Beeline APIs in your test environment.

1
Retrieve your API credentials
  1. Login to your Beeline extended workforce platform.
  2. Click the Help icon in the Navigation ribbon in the upper right of the page, and then select API Authentication. A Beeline Integrations Portal page displays.
  3. Scroll down to the Auth0 Credentials field to view your Client ID and Client Secret.
2
Request an access token

Send a POST request with the following payload body to the authorization server; where audience=the base URL for the API you're using. Go to API Products to find the applicable base URL for the API you're using.

Authorization server URL: https://azure-prj.auth.beeline.com/oauth/token
Example payload for the Client Onboarding API:
{
    "client_id":"myid",
    "client_secret":"mysecret",
    "audience":"https://edge.beeline.com/client-onboarding",
    "grant_type":"client_credentials"
}
Caution: Do not commit your Client ID and your Client Secret because they are private.
The authorization server will respond with a JSON object containing these properties.
{
    "access_token": "your_token_would_be_here",
    "expires_in": 1800,
    "token_type": "Bearer"
}

Access tokens expire 30 minutes after they're issued. Use the POST request to get a new token whenever you need.

You're ready to call Beeline APIs.

3
Call a Beeline API using your access token

Add an authorization header to your requests with the value Bearer {access_token}, where access_token=the token you just obtained:

Authorization: Bearer {access_token}

After your application is ready to use, you may want to move it to your Production environment. Check the confirmation email you received for instructions on implementing a Beeline API in your Production environment.

Need help?

Do you need help with or have questions about Beeline's APIs? Do you have general questions, comments, suggestions, or specific requirements? Beeline is here to assist you!

Get Support