Кардпул

Общая информация

В SailPlay реализована возможность загрузки списка карт и последующее получение карт из него с помощью API.

Полученные значения возможно получить, как атомарно, так и сразу с записью для какого-либо клиента.

Наиболее часто этот функционал используется для "генерации" и выдачи виртуальных номеров карт, которые могут быть подставлены в письмо, но не имеют физического носителя.

Каждый код может быть получен из группы только 1 раз.

При записи для пользователя проверяется - не записаны ли эти origin_user_id у других пользователей. В случае, если это произошло - выбранный код пропускается и берется следующий. Количество таких попыток - 5.

Методы API

Создание пула номеров карт осуществляется через отправку .txt файла через POST запрос, содержащего по одному номеру на каждой строке.

При загрузке, помимо авторизационных данных, необходимо указать наименование группы, в которую будут добавлены загруженные номера карт. В случае успешной обработки запроса будет создана группа с указанным наименованием вместе с кодами из файла.

📘

Инфо

В каждую из групп можно загрузить несколько разных файлов - они будут дополняться, но в самой группе будут сохранены только уникальные значения

После создания группы к ней можно обращаться с целью получения номера карты. Для этого в Sailplay API реализованы два метода:

/partners/origin-user-ids/allocate/ - возвращает код из группы, указанной в параметре group_name. В системе код будет отмечен, как выданный. Данный код в дальнейшем может быть использован для выдачи клиенту.

Метод /partners/origin-user-ids/allocate-and-assign/ - также возвращает номер карты из группы и автоматически присваивает его клиенту, идентификатор которого был передан в запросе.

🚧

Важно

При использовании метода /partners/origin-user-ids/allocate-and-assign/ выданный код будет сразу присвоен указанному клиенту, как origin_user_id. Если у клиента уже был указан данный идентификатор, то значение будет перезаписано.