Authentication

Platform API Key

To access the platform API you'll need a platform API Key. The key grants unrestricted access to platform API and is provided by and to ShopGo's internal product teams.

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/platform/auth/test

Use this endpoint to test a platform API key. 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

200

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

401

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