Метод позволяет регистрировать пользователей как реселлерам, так и обычным пользователям. Полезен для партнёрских сайтов, желающих создать свою собственную страницу регистрации. Регистрируемый пользователь в таком случае автоматически закрепляется за партнёром. Обычный пользователь также может использовать метод register для ряда случаев.
Например, во время использования плагинов к CMS. В результате пользователь может установить себе плагин, не будучи даже зарегистрированным в Unisender, поскольку плагин сам отправляет запрос на регистрацию. Поскольку это не безопасное действие, устанавливаются некоторые ограничения для обычных пользователей на количество и частоту регистраций.
Один раз в минуту с одного IP есть возможность зарегистрировать пользователя обычным пользователям.
Пользователь может регистрировать один аккаунт в минуту, для этого даже не быть пользователем Unisender. Для этого необходимо передать параметр need_confirm=1 (и не передавать api_key).
Принцип использования
Синтаксис и URL для вызова метода |
register (string email) |
https://api.unisender.com/ru/api/register?format=json&email=MAIL |
Аргументы | |
email * | Email-адрес регистрируемого пользователя. |
api_key | Ключ доступа к API текущего пользователя (у пользователя должно быть право reseller). |
need_confirm | подтверждение регистрации (письмо-подтверждение регистрации для нового пользователя), принимает значения 0 и 1. По умолчанию 0 (подтверждение не требуется). Значение 0 доступно только для реселлеров. А если передано значение 1 - методом могут воспользоваться все пользователи. |
password | Пароль для нового пользователя. Если не указан, то генерируется случайный. |
notify | 0 или 1 (по-умолчанию 0) – посылать ли новому пользователю приветственное письмо с паролем. |
extra | Ассоциативный массив дополнительных полей. Поддерживаются дополнительные поля: «firstname», «channel», если need_confirm = 1 то extra может принимать еще 3-три параметра «lastname», «company», «phone». |
timezone | Часовой пояс пользователя в формате, который описан здесь: http://php.net/manual/ru/timezones.php. Если часовой пояс не указан, то будет использован UTC.
Также если пояс не найдено будет предупреждение: {"warning": "Unknown timezone, set to UTC"} и установлено значение "ZZZ". |
country_code | Трёхбуквенный код страны по ISO 3166-1 alpha-3. Если не указан, будет установлено значение «ZZZ». |
currency_code | Трёх буквенный код валюты счёта пользователя. На данный момент возможны RUB, USD, EUR и UAH.
Если не указано или валюты не найдено подставляется USD (исключение при русской локализации RUB). Также если указанной валюты не найдено будет предупреждение: {"warning": "Unknown currency code"} |
ip | IP-адрес, с которого поступила заявка о регистрации, в формате «NNN.NNN.NNN.NNN». |
test_mode | Тестовое создание пользователя, принимает значения 0 (выкл), 1 (вкл) по умолчанию 0. |
Возвращаемое значение | |
В случае успешного завершения – объект c одним полем api_key, в котором возвращается ключ для выполнения запросов к API от имени вновь зарегистрированного пользователя.
{ "result": { "api_key": "5skfgjkhfgdfgdhfgkhdkg" } } В тестовом режиме всегда возвращается api_key равным 12345678. |