Authentication

Hosted Services

The SaaS version of Babel Street Analytics is rapidly implemented, low maintenance and ideal for users who wish to pay based on monthly call volume.

Analytics uses API keys to allow access to the API. You can find your API Key on the Analytics Developer Portal or Sign Up for a new API key.

All endpoints expect the API Key to be passed as an HTTP header:

-H "X-BabelStreetAPI-Key: [your_api-key]"

You must replace [your_api_key] with your personal API key.

On-Premise Installations

Server is the on-premises installation of Analytics, with access to Analytic’s functions as RESTful web service endpoints. This solves cloud security worries and allows customization (models/indexes) as needed for your business.

When Analytics is installed on premise, no authentication is required. The code examples shown here include authentication. When using these examples, make the following changes:

Omit this authentication from your calls:

-H "X-BabelStreetAPI-Key: [your_api-key]"

Substitute the IP address of your instance for analytics.babelstreet.com wherever https://analytics.babelstreet.com/rest/v1/[endpoint] is mentioned.

Server can be configured by modifying the configuration files in the installation, in addition to the call parameters documented here. Refer to the Server User Guide for configuration details.