<aside> 💡 Общий метод, контекст клиента, V=0
</aside>
Данный метод необходим для первоначального получения токена клиента, чтобы иметь возможность выполнять запросы к API уровня пользователя.
<aside> ⚠️ ОЧЕНЬ ВАЖНО! Указанный метод НЕ является методом авторизации или аутентификации пользователя, а обеспечивает ТОЛЬКО механизм идентификации клиента внутри системы XCore по переданным через API параметрам.
</aside>
Так как метод GetClients является механизмом идентификации клиента, то процедуру авторизации пользователя необходимо реализовать в вашей системе.
<aside> ☝🏻
</aside>
| Параметр | REQ | Описание |
|---|---|---|
| PhoneNumber | да | Телефон – в международном формате, включая код страны - 79629031736 |
| MainPhoneOnly | “Основной телефон” - флаг представляющий собой(при значении true) указание искать телефон только среди «основных» номеров клиентов(если не задан интерпретируется как false) | |
| ClientTypes | Тип клиента (список значений перечисления ClientLegalTypes) (если не задан, то фильтрации по этим значениям не будет) - см. значения: ‣ | |
| PassportSeries | Серия паспорта – строка серии паспорта(имеет смысл только для физиков и ИП) | |
| PassportNumber | Номер паспорта – строка номера паспорта(имеет смысл только для физиков и ИП) | |
| BirthDate | Дата рождения в формате dd.MM.yyyy | |
| Inn | ИНН | |
| Ogrn | ОГРН(ИП) имеет смысл только для юр лиц или ИП | |
| ContractNumber | Номер договора – строка номера договора | |
| IntegrationId | Токен клиента – уникальный код однозначно определяющий клиента |
Важно понимать, что данный метод можно использовать не только для идентификации клиента, но и для проверки наличия клиента с определенными параметрами в базе данных. Например, если нужно проверить существует ли клиент с указанным токеном, то в параметрах запроса достаточно проинициализировать параметр IntegrationId. Но для предупреждения “перебора” базы данных параметр телефона клиента является обязательным, а все остальные параметры - дополнительными.
Если в результате выполнения метода вернулась пустая коллекция, значит условиям фильтрации НЕ соответствует НИ один клиент.
Если в коллекции содержится один элемент - получили однозначное соответствие.
Если в коллекции ответа присутствует несколько элементов, то значит в базе данных содержится несколько клиентов с указанными параметрами и имеет смысл сузить параметры идентификации.
Важным моментом идентификации по номеру телефона является факт, что в базе данных может существовать несколько клиентов с указанным номером (дубликаты по номеру телефона). В этом случае реакция на дубли остается целиком и полностью на стороне вызывающей API стороне.
Объект запроса
{
PhoneNumber: "79629031736",
MainPhoneOnly: 1,
ClientTypes: [0, 1],
PassportSeries: "",
PassportNumber: "",
Inn: "",
Ogrn: "",
ContractNumber: "",
IntegrationId: "",
BirthDate: "1900.01.01 00:00:00"
}
Clients - коллекция элементов Объект Клиент