Отримання списку персоналу

Офіціантів і курʼєрів. Необхідно для повідомлень і персоналізації чайових.

Для отримання списку персоналу закладу, Expirenza надсилатиме наступне повідомлення:

usersInfo

{
    "rID" : "2021-03-13 00:32:04.942046#UP57RxE",
    "operation" : "usersInfo"
}

❗️ Обов'язкові елементи запиту: rID, operation.

Відповідь обробки операції необхідно надіслати в наступному вигляді:

Сервіс передачі інформації про користувачів ресторану

post

Header parameters

restoIdstringRequired

Ідентифікатор ресторану

signaturestringRequired

Підпис запиту

Body

application/json

rIDstringOptional

Ідентифікатор запиту в системі Shake To Pay

Example: Look for payload example: /callback/usersInfo

Responses

200

Запит отримно та оброблено успішно

post

/callback/usersInfo

HTTPcURLJavaScriptPython

POST /callback/usersInfo HTTP/1.1
Host: api.shaketopay.com.ua
restoId: text
signature: text
Content-Type: application/json
Accept: */*
Content-Length: 178

{
  "rID": "Look for payload example: /callback/usersInfo",
  "users": [
    {
      "cellPhone": "[phone]",
      "id": "ab863-78",
      "name": "Петро",
      "roles": "Официант, Кладовщик"
    }
  ]
}

200

Запит отримно та оброблено успішно

No content

Payload example: /callback/usersInfo

JSON

{
  "rID": "2021-04-01 09:39:06.021078#BpOI0gO",
  "users": [
    {
      "cellPhone": "[phone]",
      "id": "ab863-78",
      "name": "Петро",
      "roles":["Кухар універсал","Су-шеф кухар"]
    }
  ]
}

---

Окремо реалізовано апі для проактивного отримання списку користувачів.

Цей функціонал також рекомендовано до реалізації. Цей варіант є більш реактивним за usersInfo. Expirenza очікує отримання хука про оновлення одного юзера кожен раз, коли юзер зазнав змін, видалився або був створений.

З використанням апі проактивного отримання списку користувачі - інтеграція сама ініціює оновлення користувачів в системі Expirenza.

Вебхук для оновлення одного юзера.

Сервіс отримання відповіді від ресторану про зміни у користувачах

post

Header parameters

restoIdstringRequired

Ідентифікатор ресторану

Body

application/json

webhookTypestringRequired

Тип вебхука: 'USER_CHANGED'

Example: USER_CHANGED

eventTimestring · date-timeRequired

Час події у форматі ISO 8601

Example: 2024-07-28T19:29:17Z

actionstringRequired

Тип дії: 'UPDATED','CREATED','REMOVED'

Example: UPDATED

Responses

200

Запит отримано та оброблено успішно

post

//api.shaketopay.com.ua/callback/webhook

HTTPcURLJavaScriptPython

POST //api.shaketopay.com.ua/callback/webhook HTTP/1.1
restoId: text
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "webhookType": "USER_CHANGED",
  "eventTime": "2024-07-28T19:29:17Z",
  "action": "UPDATED",
  "user": {
    "id": "someId",
    "cellPhone": "[phone]",
    "name": "Pipikonda"
  }
}

200

Запит отримано та оброблено успішно

No content

Payload example /callback/webhook:

{
  "webhookType":"USER_CANGED",
  "eventTime":"2024-07-28T19:29:17Z",
  "action": "UPDATED",
  "user":{
    "id":"someId",
    "cellPhone":"[phone]",
    "name":"Cat Expirenza"
  }
}

---

Вебхук для оновлення всіх юзерів.

Передбачає оновлення всіх користувачів у системі POS.

Expirenza очікує отримання хука про оновлення всіх юзерів при запуску інтеграції і далі з переодичністю раз на добу.

Рекомендації щодо використання:

1. При запуску POS-системи.

2. З інтервалом на добу.

Сервіс отримання відповіді від ресторану про оновлення всіх користувачів

post

Header parameters

restoIdstringRequired

Ідентифікатор ресторану

Body

application/json

webhookTypestringRequired

Тип вебхука, наприклад 'UPDATE_ALL_USERS'

Example: UPDATE_ALL_USERS

eventTimestring · date-timeRequired

Час події у форматі ISO 8601

Example: 2024-09-19T12:05:35.2537443Z

Responses

200

Запит отримано та оброблено успішно

post

//api.shaketopay.com.ua/callback/webhook

HTTPcURLJavaScriptPython

POST //api.shaketopay.com.ua/callback/webhook HTTP/1.1
restoId: text
Content-Type: application/json
Accept: */*
Content-Length: 179

{
  "webhookType": "UPDATE_ALL_USERS",
  "eventTime": "2024-09-19T12:05:35.2537443Z",
  "users": [
    {
      "id": "993332e8-bfea-460d-99c3-9fcba5f944ca",
      "name": "Офік",
      "cellPhone": "[phone]"
    }
  ]
}

200

Запит отримано та оброблено успішно

No content

Payload example /callback/webhook:

{
    "webhookType": "UPDATE_ALL_USERS",
    "eventTime": "2024-09-19T12:05:35.2537443Z",
    "users": [
        {
            "id": "993332e8-bfea-460d-99c3-9fcba5f944ca",
            "cellPhone": "[phone]",
            "name": "Cat Expirenza"
        },
        {
            "id": "someId",
            "cellPhone": "[phone]",
            "name": "Cat Mono"
        }
    ]
}