03API reference
Version 1.0.0Made from openapi.yaml
Meta
The definition itself, and who a key is.
Who this key is
GET
/meScoped private key (rm_prv_), from a server
The key, the store, what the key may do and its limits. Any key that is not an FFL Checkout key. Use it at install time to check a pasted key.
Responses
Headers: X-Request-Id, X-RateLimit-Remaining
| Field | Type | Description |
|---|---|---|
datarequired | object | |
data.storerequired | object | |
data.store.id | integer | |
data.store.name | string | |
data.keyrequired | object | |
data.key.idrequired | string | |
data.key.kindrequired | "public" | "private" | |
data.key.familyrequired | "catalog" | "checkout" | |
data.key.permissionsrequired | string[] | |
data.planrequired | "essentials" | "connect" | "pro" | "checkout" | |
data.featuresrequired | object | |
data.features.distributor_orders | "none" | "draft" | "placed" | |
data.features.inventory | boolean | |
data.limitsrequired | object | |
data.limits.requests_per_minute | integer |
Example
Shell
This definition
GET
/openapi.jsonNone
The OpenAPI 3.1 document of the API, as JSON. No key needed.
Responses
No body.
Example
Shell