Create an API key

Creates an API key for one API, chosen with scope. A Customer key (the default) lets a partner call the customer API on behalf of the shoppers of this marketplace (login by email and order number without the browser origin checks, own rate limit). A Merchant key opens sessions on this API through POST /login/api-key, acting as userId: only a StoreOwner creates them. The key is returned once, in this response only.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 100

Name that identifies who uses the key (the partner or the integration).

string
enum
Defaults to Customer

The API the key is for. Customer: a partner logs in as the shoppers of the shop on the customer API. Merchant: the key opens sessions on this API as userId (only a StoreOwner creates these).

Allowed:
uuid

Merchant keys only, and required for them: the enabled user of the shop the key acts as. Its sessions get the roles and modes of that user, and end when the user is disabled, deleted or loses one of them.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json