База клиентов

Получение информации о госте (баланс бонусов или порядковый номер стакана по акции) по номеру телефона или номеру карты

POST https://api.ytimes.ru/ex/client/loadClientInfo

Headers

Name	Type	Description
Authorization*	string	Ключ авторизации

Request Body

Name	Type	Description
json body*	string	{ "cardNumber" : 45 } или { "phoneCode": "7", "phone": "9001112233" }

200 Если гость существует, то вернется информация о нем, если же гость не существует, вернется пустой результат. В примере ниже у гостя 45.5 накопленных бонусов и 7 купленных стаканов по акции (то есть следующий стакан будет 8-й)

{
  "success": true,
  "count": 1,
  "rows": [{
    //сколько уже заказано стаканов по акции
    "orderPromoCount": 7,
    //сколько бесплатных стаканов у гостя было накоплено ранее и не потрачено
    "orderPromoFreeCount": 0,
    //количество накопленных бонусов
    "points": 45.5
  }],
  "error": null
}

Создание гостя в базе и пополнение ему баланса

POST https://api.ytimes.ru/ex/client/createClientAndAddPoints

Возможность создать гостя в базе и пополнить ему баланс. Если при вызове метода гость уже существует в базе, то только пополнится баланс на указанную сумму. Обязательные поля только phoneCode, phone, то есть телефон для идентификации пользователя.

Поле requestId определяет ключ идемпотентности, чтобы предотвратить повторное срабатывание. Несколько запросов с одинаковым requestId сработают только один раз. В поле value передаем количество бонусов, на которые нужно пополнить баланс гостя (или уменьшить, если передать со знаком минус). Так же обратите внимание, что на своей стороне необходимо предусмотреть процесс идентификации гостя (подтверждения телефона) например через СМС, чтобы убедиться, что гость указал именно свой телефон на вашем ресурсе.

Headers

Name	Type	Description
Authorization*	string	Ключ авторизации

Request Body

Name	Type	Description
json body*	string	{ "requestId": UUID, "phoneCode": "7", "phone": "9001112233", "name": "Никита", "surname": "Иванов", "email": "[e-mail]", "birthday": "10.01.2000", "sex": "MALE", "isAgreeToNotification": false, "comment": "комментарий к карте гостя", "sourceId": null, //ID источника гостя для статистики (опционально) "value": 100, "valueComment": "за регистрацию" (опционально) }

200 Если запрос выполнился успешно, в ответе будет success: true, иначе сообщение об ошибке

{
  "success": true,
  "count": 0,
  "rows": [],
  "error": null
}