API Keys
Operations related to API keys
All endpoints require a JWT Bearer token in the Authorization header.
POST /v1/api-keys
Create a new API key
Request body (required)
Merchant IDs or brand ID to associate with the new API key
Field | Type | Required | Description |
|---|---|---|---|
|
| No | List of merchant IDs that can use this API key |
|
| No | _id field of a brand. |
Responses
Status | Description |
|---|---|
| API key created successfully |
| Invalid input |
| One or more merchant IDs were not found |
201 response schema
Field | Type | Required | Description |
|---|---|---|---|
|
| No | The created API key |
DELETE /v1/api-keys
Delete an existing API key
Request body (required)
API key to delete
Field | Type | Required | Description |
|---|---|---|---|
|
| Yes | The API key to remove from the system |
Responses
Status | Description |
|---|---|
| API key deleted successfully |
| API key not found |