API Key

Overview

The API Key is a secret software credential that allows the program to access your account without the need for providing an actual username and password to the software. The API credential key credentials should be treated as valuable as a username and password. The API key is used to state who the user is and can be sent in plain text and this is used for encryption.

To successfully use the Lightstone Search UI, Subscription and API keys will be required and can be obtained by signing up on the Lightstone Developer Portal. The subscription key is used to identify your account and you will be asked to provide one to connect successfully to the Search UI. You can find the subscription key in the Lightstone Developer Portal Profile page and are able to create new subscription keys in the same section if necessary. The API key is an identity by which identifies the application or the user. An API key consists of code passed between an API and an application service. The code will call the programs from another application and then the API key will identify the end-user-the developer of the code and the application making the API call. Therefore we can confirm that the API key acts as an authentication token or a unique identifier.

Before you begin

To use the Lightstone Search UI, you first have to register on the Lightstone Developer Portal to obtain a Subscription and API key to navigate through the Search UI successfully. You are able to Show/Regenerate your subscription secret keys in your Profile tab from the Lightstone Developer Portal as per the below screenshot:

The Lightstone Developer Portal provides all the API endpoints that each have a unique API key that can be found when clicking on a specific endpoint.

Creating API keys

The API key is a unique identifier that authenticates requests associated with your project for usage and billing purposes. You must have at least one API key associated with your project. The API key needs to be unique, random and non-guessable and the API keys that will be generated must be Alphanumeric and have special characters.

1. On the Developer Portal, navigate to the username icon to view the Profile User settings for your subscription and applications.
2. In the Developer Portal profile access section, you will be able to create or regenerate an API Subscription key

• Our Developer Portal provides a Primary and a Secondary key

Note: All API access is drawn from our Live environment, therefore API usage will need to be specified with a Lightstone Account Manager.

Adding the API key to your request

You must include an API key with every request.