# 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.

{% hint style="danger" %}
Take extra care when using the platform API key as it can be used to modify the records of any tenant on the platform.
{% endhint %}

## Test API Key

<mark style="color:blue;">`GET`</mark> `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 |

{% tabs %}
{% tab title="200 " %}

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

{% endtab %}

{% tab title="401 " %}

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

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.shopgo.me/platform-api/authentication.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.