iRetail PRO store node 1.0.0-m1: me
2 операции
← Вся документация · Источник: контракты, openapi/store-v1.yaml на коммите 8000474.
Справочники на английском — на языке контрактов, из которых они созданы.
← iRetail PRO store node 1.0.0-m1
Операции
GET
/v1/me
The caller and its effective permissions in its context.
operationId
me
Параметры
| Имя | Где | Тип | Описание |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
Ответы
PUT
/v1/me/pin
Set a new PIN for the signed-in employee, giving the current one (spec/RBAC.md, PINs).
An employee's session only; the current PIN counts as an attempt of the session's device. The only change a session with pin_change_required may make. A store of a chain carries it out at its hub (spec/SYNC.md, Forwarded operations).
operationId
changeOwnPin
Параметры
| Имя | Где | Тип | Описание |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
Тело запроса обязательный
application/jsonPinChange
Ответы
Схемы
Error object
Every error response.
error обязательный
|
string |
Stable code, see spec/API.md. |
message обязательный
|
string |
English text for logs. |
details
|
object |
Principal object
kind обязательный
|
"employee" | "device" | "integration" |
|
id обязательный
|
string (uuid) |
|
display_name обязательный
|
string |
EffectivePermission object
code обязательный
|
string |
|
limit обязательный
|
integer (int64) | null |
Me object
principal обязательный
|
Principal |
|
store_id обязательный
|
string (uuid) |
|
workplace_id обязательный
|
string (uuid) | null |
|
permissions обязательный
|
array of EffectivePermission |
PinChange object
current_pin обязательный
|
string |
|
pin обязательный
|
string |