Group 65 Вернуться на сайт

Клиенты

December 26, 2019 Интеграция API 0 minutes, 27 seconds
  1. Создание нового клиента

Для того, чтобы создать нового клиента и сгенерировать для него карту, необходимо отправить POST-запрос на адрес:

https://[HOST].ucards.by/remote_api/clients/create/single

Пример тела запроса:

{
    "data": {
        "name": "Кирилл", 
        "phone": "+375298873380"
    }
}
  1. Получение списка всех клиентов

Необходимо отправить GET-запрос на адрес

https://[HOST].ucards.by/remote_api/clients/list
  1. Получение данных клиента по номеру карты:

Необходимо отправить GET-запрос на адрес

https://[HOST].ucards.by/remote_api/clients/bySN/[CARD_NUMBER]
  1. Изменение значения полей клиента:

Внешние поля:

https://[HOST].ucards.by/remote_api/clients/[CARD_NUMBER]/update/editable

Пример тела запроса:

{
    "editableField1": 1
}

Внутренние поля:

https://[HOST].ucards.by/remote_api/clients/[CARD_NUMBER]/update/inner

Пример тела запроса:

{
    "innerField1": 1
}

Подробнее о внешних и внутренних полях можно почитать тут: Названия полей