Access Keys

Authorization is the function of specifying access rights to resources such as APIs. More formally, "to authorise" is to define an access policy where access requests are approved or disapproved. So, Access Keys are used for this purpose.

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

Here, the key which is auto-generated is associated with the user selected, once it is enabled. Anyone can use this access key but can access only those APIs of which the selected user has the permission to access based on his role (admin/seller/user...etc.).

User

Select the User from the drop-down for which you want to generate the access key.

Enable

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

How to use the access key to access any API?

You can use this access key to access APIs via StoreHippo node-js SDK. 

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

var request = require('request');
var options = {
    url: "http://example.com/api/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);
    console.log("Body >>>>> ", body);
});