Using Platform API Key

Overview

The platform API key can be requested by contacting ShopGo's product team. This is intended for internal use and getting it is subject to an approval process.

When using this authentication mechanism, an additional request header must be supplied to specify which tenant accountshould be accessed. The details are described in Test API Key below.

Take extra care when using the platform API key as it can be used to modify the records of any tenant on the platform.

Test API Key

GET https://api.shopgo.me/v1/management/auth/test

Use this endpoint to test authentication. The same request format can be used to authenticate access to all management API endpoints.

Headers

Name	Type	Description
X-API-KEY	string	platform API key
X-TENANT-ID	number	unique tenant identifier

200

{
    "result": "success",
    "payload": {}
}

401

{
    "result": "error",
    "description": "unauthorized"
}

For convenience, it's possible to replace X-TENANT-ID with a similar header X-TENANT-NAME that accepts the tenant's name (String).