Using User API Key

Overview

The dashboard user's API key can be obtained by calling a key endpoint and providing the user's email and password (see Retrieve API Key below).

Once a key is obtained, it can be used to authenticate requests as described in Test API Key.

Retrieve User API Key

POST https://api.shopgo.me/v1/management/auth/key

Use this endpoint to retrieve the API key of a dashboard user.

Request Body

Name	Type	Description
email	string
password	string

200

{
    "result": "success",
    "payload": {
        "api_key": "<key-here>",
        "user_id": "<user-id>",        
        "tenant_id": "<tenant-id>",
        "tenant": <Tenant>,
        "user": <DashboardUser>,
    }
}

401

{
    "result": "error",
    "description": "incorrect credentials"
}

For a full breakdown of response objects, see Tenant and DashboardUser.

Test Authentication

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	dashboard user API key

200

{
    "result": "success"
}

401

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