Авторизация | API | Collaborator - Справочная информация и описание системы


См. Авторизация

Для импорта одного пользователя нужно отправить POST запрос на URI /api/rest.php/imports-user?action=single-import
в теле запроса должен быть JSON объект с информацией о пользователе. Запрос должен содержать загловоки Content-Type: application/json;charset=UTF-8 и Authorization: Bearer xxxxxx. Пример запроса:

curl 'http://localhost:8080/api/rest.php/imports-user?action=single-import' -H 'Authorization: Bearer xxxxxx' -H 'Content-Type: application/json;charset=UTF-8' --data-binary '{"uid":"cl123456", "secondname":"Smith", "firstname":"John", "patronymic":"", "login":"john.smith", "email":"john.smith@test.me", "password":"1", "birth_date":"26.07.1988", "gender":0, "is_active":1, "city":"Kiev", "department":"Dep1", "position":"CEO", "tags":"tag1,tag2", "phone":"0971111111"}'
тут вместо локального адреса http://localhost:8080 нужно использовать адрес вашего сервера.


Формат объекта с информацией о пользователе

* Звездочкой отмечены обязательные поля

ПолеТипОписание
uid*СтрокаУникальный идентификатор
secondname*СтрокаФамилия
firstname*СтрокаИмя
patronymicСтрокаОтчество
login*СтрокаЛогин
email*СтрокаEmail
password*СтрокаПароль
birth_dateСтрокаДата рождения, в формате ДД.ММ.ГГГГ или ГГГГ-ММ-ДД, например 26.07.1988 или 1988-07-26
genderЧислоПол, 0 - мужской, 1 - женский, если поле не задано - игнорируется
is_activeЧислоФлаг, указывает включен ли пользователь в системе, 1 - включен, 0 - заблокирован
cityСтрокаГород
departmentСтрокаОтделение
position*СтрокаДолжность
phoneСтрокаТелефон, в международном формате, например +380971234567
tagsСтрокаСписок меток, разделенных запятой
facebook_idСтрокаid пользователя в Facebook
google_idСтрокаid пользователя в Google
date_of_employmentСтрокаДата приема на работу, в формате ДД.ММ.ГГГГ или ГГГГ-ММ-ДД, например 26.07.1988 или 1988-07-26
work_contactСтрокаРабочие контакты

Ответ

В случае успешного запроса (HTTP код ответа - 200), будет ответ в формате JSON с информацие о количестве обработанных записей:
{"created_count":1,"updated_count":0,"blocked_count":0,"unblocked_count":0}

  • created_count - будет равно 1 если новый пользователь был создан в системе
  • updated_count - будет равно 1 если существующий пользователь был обновлен в системе
  • blocked_count - будет равно 1 если в процессе обновления ранее активный пользователь был заблокирован
  • unblocked_count - будет равно 1 если в процессе обновления ранее заблокированный пользователь был включен

В случае ошибки (HTTP код ответа - 400) возвращает JSON объект с информацией о ошибке:
{"email":{"required":"Field cannot be empty","email":"Invalid email"}}

см. также Работа с пользователями


Авторизация | API | Collaborator - Справочная информация и описание системы