Access Keys

StoreHippo offers API (Application Programming Interface) endpoints to programmatically manage the different platform services and also to integrate the store with third party applications including ERP solutions, POS, Accounting Software, Self Service Portals etc.

StoreHippo uses Access keys to authenticate the API clients and also define the access policy for the API requests.

You can manage these access keys in the Advance Settings > Access Keys section of StoreHippo Admin Panel.

How to add/generate a new access key?

To add a new access key, click on the Add new button on the panel. Clicking on the Add new will open a form with the following fields.

Access key

The access key is 24 characters long alphanumeric key that is auto-generated. 

User

Select the User from the drop-down for which you want to generate the access key. The generated access key will have permissions accordingly to the role of the specified user.

Enable

Select the Enable checkbox if you want to enable the access key for the user. 

How to use the access key?

StoreHippo offers REST API endpoints to access the StoreHippo APIs. You can use any programming language of your choice. All you need to do is to pass the access key in the HTTP request header.

Here is an example below of how to use this auto-generated access key to access products listing API using Nodejs.

var request = require('request');
var options = {
    url: "https://example.com/api/1.1/entity/ms.products",
    headers: {}
}
options.headers['access-key'] = 'access-key';
request(options, function (err, response, body) {
    console.log("Error >>>>> ", err);
    console.log("Response >>>>> ", response);
});