OneBox
OneBox Rest API
API користувачі (User)

API користувачі (User)

Додавання контакту, метод: /api/contact-add/json/

Параметри

Приклад:

http://myboxurl/api/contact-add/json/?login=LOGIN&password=PASSWORD&name=user123&email=user123@user.com&distribution=1&typesex=man&level=2&userlogin=userlogin&company=company&namemiddle=батькові&namelast=прізвище&commentadmin=commentadmin&parentid=24&country=Країна®ion=область&district=Район&city=місто&street=Вулиця&street_number=номердома&apartment=Квартира&phone=80639350555&userpass=123456789A&code1c=code1c&pricelevel=Ціна 1&customfield_key1=customvalue1&customfield_key2=2016-01-01

Так само є можливість заповнення додаткових полів контактів. Для цього в якості змінної вказується ідентифікатор додаткового поля, а значення приймаються з тими ж типами, що і вказане поле

№	Поле	Тип	Опис	Обов'язкове чи ні	Коментар
1	login	string	Логін в системі BOX	Обов'язкове поле.
2	password	string	Пароль в форматі md5	Обов'язкове поле.	Напишіть в техпідтримку і ми видамо вам hash для API
3	name	string	ім'я користувача	Не обов'язкове поле.
4	userlogin	string	логін користувача	Не обов'язкове поле.
5	userpass	string	пароль користувача	Не обов'язкове поле.
6	email	string	email користувача	Обов'язкове поле (або email або телефон повинен бути).
7	phone	string	телефон користувача	Обов'язкове поле (або email або телефон повинен бути).
8	address	string	повну адресу користувача одним рядком (застарілий параметр)	Не обов'язкове поле.
9	country	string	Країна	Не обов'язкове поле.
10	region	string	Регіон (область)	Не обов'язкове поле.
11	district	string	Район	Не обов'язкове поле.
12	city	string	Назва населеного пункту	Не обов'язкове поле.
13	street	string	Вулиця	Не обов'язкове поле.
14	street_number	string	Номер будинку	Не обов'язкове поле.
15	apartment	string	Квартира	Не обов'язкове поле.
16	bdate	date	день народження користувача	Не обов'язкове поле.
17	parentid	integer	за рекомендацією від	Не обов'язкове поле.
18	level	integer	рівень доступу користувача	Не обов'язкове поле.	Рівні доступу: 0 - заблоковано 1 - клієнт 2 - Співробітник 3 - Адміністратор
19	commentadmin	string	коментар адміністратора	Не обов'язкове поле.
20	groupid	integer	група користувача	Не обов'язкове поле.	Ідентифікатор групи контактів в системі BOX
21	source	integer	Джерело користувача	Не обов'язкове поле.	Ідентифікатор джерела в системі BOX
22	pricelevel	string	рівень цін користувача	Не обов'язкове поле.	Назва ціни, яку ви бажаєте встановити користувачеві
23	distribution	boolean	Підписано контакт на розсилку	Не обов'язкове поле.
24	tags	string	Теги	Не обов'язкове поле.
25	namelast	string	прізвище користувача	Не обов'язкове поле.
26	namemiddle	string	батькові користувача	Не обов'язкове поле.
27	typesex	string	підлогу користувача	Не обов'язкове поле.	За замовчуванням тип користувача - чоловік. Доступні типи користувачів: man - чоловік woman - жінка company - компанія
28	company	string	компанія користувача	Не обов'язкове поле.
29	code1c	string	code1c користувача	Не обов'язкове поле.	id користувача з вашої системи
30	companyid	integer	id компанії користувача	Не обов'язкове поле.
31	companycode1c	integer	зовнішній код компанії користувача	Не обов'язкове поле.
32	emails	string	email-и користувача (додаткові)	Не обов'язкове поле.	Показувати через пробіл (test @ tset.ua dddd@ya.ru)
33	managerid	integer	id менеджера з OneBox	Не обов'язкове поле.
34	managercode	string	code1c менеджера з OneBox	Не обов'язкове поле.
35	employer	boolean	Является ли контакт сотрудником	Не обов'язкове поле.
36	phones	string	телефони користувача (додаткові)	Не обов'язкове поле.	Показувати через пробіл (380977777777 380500500550) без пробілів в самих телефонах
37	dataFromBody	boolean	Брати дані не з аргументів, а з body	Не обов'язкове поле.	Якщо переданий dataFromBody = 1, то дані будуть брати не з аргументів, а з тіла запиту. В тіло має бути переданий json, в якому ключами повинні бути параметри, описані вище. login і password пі цьому повинні посилаті як зазвичай
38	update	boolean	Оновлювати контакту якщо він знайдений по контактними даними	Не обов'язкове поле.
39	fullname	string	Полное фамилия имя отчество в одном поле	Не обов'язкове поле.	Если не указаны параметры name, namelast и namemiddle, они будут через пробел браться из fullname согласно формата в nameformat, если одна из частей ФИО отсутствует, необходимо в этом месте вставить еще один пробел
40	nameformat	string	Порядок расположения имени (f), фамилии (l) и отчества (m) в fullname	Не обов'язкове поле.	По умолчанию формат l-f-m, что означает порядок Фамилия Имя Отчество

Отримання одного контакту і отримання всіх контактів, метод: /api/contact-get/json/

Параметри

Параметри отримання одного контакту:

Приклад:

http://myboxurl/api/contact-get/json/?login=LOGIN&password=PASSWORD&userid=666

№	Поле	Тип	Опис	Обов'язкове чи ні	Коментар
1	login	string	Логін в системі BOX	Обов'язкове поле.
2	password	string	Пароль в форматі md5	Обов'язкове поле.	Напишіть в техпідтримку і ми видамо вам hash для API
3	supplierhash	string	Ключ постачальника	Не обов'язкове поле.	Доступний в картці клієнта, який є контактом постачальника. Доступний при наявності логіна і пароля від системи і рівня доступу" клієнт". Ця функція дозволяє обмежити доступ до отримання контактів згідно зв'язку додаткового поля контакту з ключем постачальника (див. Налаштування" Перевірки і унікальність") або клієнтів процесів, де даний постачальник є постачальником продуктів процесу.
4	userid	integer	ідентифікатори контакту в системі BOX	Або userid або code1c або userlogin або phone або email контакту обов'язково	Значення повертаються полів contactId - id контакту, contactNamefull - ПІБ контакту, contactCode1c - код 1С контакту, contactName - ім'я контакту, contactNamelast - прізвище контакту, contactNamemiddle - батькові контакту, contactCompany - компанія контакту, contactCompanyID - id компані контакту, contactEmail - основний email контакту, contactEmails - додаткові email контакту, contactPhone - основний телефон контакту, contactPhones - додаткові телефони контакту, contactAdress - повна адреса контакту (одним рядком), contactCountry - країна контакту, contactRegion - Регіон (область), contactDistrict - Район, contactCity - місто, contactStreet - Вулиця, contactStreetNumber - Номер будинку, contactApartment - Квартира Сукупність даних формує повна адреса контакту [contactAdress] contactTypesex - підлогу контакту (не визначено, чоловік, жінка, компанія),, contactBirthdate - дата народження контакту, contactGroupsArray - список ID і назв груп, до яких належить контакт, contactManagerid - ID менеджера контакту, contactCdate - дата створення контакту, contactPost - посаду (спеціалізація) контакту, contactSourceid - ID джерела контакту, contactSourcename - джерело контакту, contactPricelevel - рівень цін контакту, contactAuthorid - ID автора контакту, contactBonuses - бонуси контакту, contactCurrency - валюта контакту, customFieldArray - додаткові поля контакту (як key передається назва доп.поля контакту, в value - значення), legalArray - список юридичних реквізитів контакту, contactCommentadmin - Коментар адміністратора, contactCommentLast - Останній коментар до контакту, доданий через блок замітки
5	code1c	string	Ідентифікатор контакту з вашої системи (з вашого магазину)
6	phone	string	Телефон контакту
7	email	string	Емейл контакту
8	userlogin	string	Логін контакту
9	showbonus	boolean	Показати бонуси контакту	Не обов'язкове поле.	При вказівці значення параметра 1 буде відображатися поле contactBonuses з бонусами контакту
10	showbonushistory	boolean	Показати історію нарахування бонусів контакту	Не обов'язкове поле.	При вказівці значення параметра 1 буде відображатися масив contactBonusHistoryArray зі списком нарахованих бонусів
11	showbonusbycategory	boolean	Показати кількість бонусів контакту за категоріями бонусів	Не обов'язкове поле.	При вказівці значення параметра 1 буде відображатися масив contactBonusByCategoryArray зі списком кількості бонусів, розбитого по категоріям бонусів
12	searchcustomfield	boolean	Поиск контакта по значению дополнительного поля контакта	Не обов'язкове поле.	Параметр передается в виде массива, где key - ключ поля, а value - его значение

Параметри отримання всіх контактів:

Приклад:

http://myboxurl/api/contact-get/json/?login=LOGIN&password=PASSWORD&part=1
http://myboxurl/api/contact-get/json/?login=LOGIN&password=PASSWORD&part=2

№	Поле	Тип	Опис	Обов'язкове чи ні	Коментар
1	login	string	Логін в системі BOX	Обов'язкове поле.
2	password	string	Пароль в форматі md5	Обов'язкове поле.	Напишіть в техпідтримку і ми видамо вам hash для API
3	supplierhash	string	Ключ постачальника	Не обов'язкове поле.	Доступний в картці клієнта, який є контактом постачальника. Доступний при наявності логіна і пароля від системи і рівня доступу" клієнт". Ця функція дозволяє обмежити доступ до отримання контактів згідно зв'язку додаткового поля контакту з ключем постачальника (див. Налаштування" Перевірки і унікальність") або клієнтів процесів, де даний постачальник є постачальником продуктів процесу.
4	groupid	integer	id групи з якої ви хочете отримати користувачів	Не обов'язкове поле.
5	udatefrom	datetime	дата поновлення користувача починаючи з дати в форматі Ymd H: i: s	Не обов'язкове поле.
6	udateto	datetime	дата поновлення користувача до дати в форматі Ymd H: i: s	Не обов'язкове поле.
7	typesex	string	Тип контактів	Не обов'язкове поле.	Необхідно передавати ключ типів контактів (наприклад company)
8	custom_[ключ]	optional	Фільтрація за додатковими полями контактів	Не обов'язкове поле.
9	part	integer	Частина товарів	Обов'язкове поле.	API видає в 1й частини до 1000 контактів, щоб отримати такі 1000 товарів передайте туди 2 (виходить частина 2) і тд. Значення повертаються полів contactId - id контакту, contactNamefull - ПІБ контакту, contactCode1c - код 1С контакту, contactName - ім'я контакту, contactNamelast - прізвище контакту, contactNamemiddle - батькові контакту, contactCompany - компанія контакту, contactCompanyID - id компані контакту, contactEmail - основний email контакту, contactEmails - додаткові email контакту, contactPhone - основний телефон контакту, contactPhones - додаткові телефони контакту, contactAdress - повна адреса контакту, contactCountry - країна контакту, contactRegion - Регіон (область), contactDistrict - Район, contactCity - місто, contactStreet - Вулиця, contactStreetNumber - Номер будинку, contactApartment - Квартира Сукупність даних формує повна адреса контакту [contactAdress] contactTypesex - підлогу контакту (не визначено, чоловік, жінка, компанія), contactBirthdate - дата народження контакту, contactGroupsArray - список ID і назв груп, до яких належить контакт, contactManagerid - ID менеджера контакту, contactCdate - дата створення контакту, contactPost - посаду (спеціалізація) контакту, contactSourceid - ID джерела контакту, contactSourcename - джерело контакту, contactPricelevel - рівень цін контакту, contactAuthorid - ID автора контакту, contactBonuses - бонуси контакту, contactCurrency - валюта контакту, customFieldArray - додаткові поля контакту (як key передається назва доп.поля контакту, в value - значення) Так само доступна фільтрація контактів по повертається полях. Необхідно передати параметр рівний назвою повертається змінної і значення для фільтрації по полю змінної. Наприклад, при передачі параметра contactCountry = Україна - будуть отфильтрованием контакти, у яких в адресу країною вказано" Україна"
10	showbonus	boolean	Показати бонуси контакту	Не обов'язкове поле.	При вказівці значення параметра 1 буде відображатися поле contactBonuses з бонусами контакту
11	showbonushistory	boolean	Показати історію нарахування бонусів контакту	Не обов'язкове поле.	При вказівці значення параметра 1 буде відображатися масив contactBonusHistoryArray зі списком нарахованих бонусів
12	showbonusbycategory	boolean	Показати кількість бонусів контакту за категоріями бонусів	Не обов'язкове поле.	При вказівці значення параметра 1 буде відображатися масив contactBonusByCategoryArray зі списком кількості бонусів, розбитого по категоріям бонусів
13	getmultiple	boolean	Получить массив результатов поиска контактов с дополнительной фильтрацией	Не обов'язкове поле.	Данный параметр работает, если заполнен хотя бы один из параметров для поиска одного контакта userid, code1c, phone, email, userlogin, searchcustomfield

Редагування контакту, метод: /api/contact-update/json/

Параметри

Приклад:

http://myboxurl/api/contact-update/json/?login=LOGIN&password=PASSWORD&userid=666&email=test@tst.com

№	Поле	Тип	Опис	Обов'язкове чи ні	Коментар
1	login	string	Логін в системі BOX	Обов'язкове поле.
2	password	string	Пароль в форматі md5	Обов'язкове поле.	Напишіть в техпідтримку і ми видамо вам hash для API
3	userid	integer	Або userid або code1c контакту обов'язково	Обов'язкове поле.
4	code1c	string	Ідентифікатор контакту з вашої системи (з вашого магазину)	Не обов'язкове поле.
5	userlogin	string	Логін контакту	Не обов'язкове поле.
6	userpass	string	Пароль контакту	Не обов'язкове поле.
7	name	string	ім'я користувача	Не обов'язкове поле.
8	email	string	email користувача	Не обов'язкове поле.
9	emails	string	email-и користувача (додаткові)	Не обов'язкове поле.	Показувати через пробіл (test @ tset.ua dddd@ya.ru)
10	phone	string	телефон користувача	Не обов'язкове поле.
11	phones	string	телефони користувача (додаткові)	Не обов'язкове поле.
12	address	string	повну адресу користувача одним рядком (застарілий параметр)	Не обов'язкове поле.
13	country	string	Країна	Не обов'язкове поле.
14	region	string	Регіон (область)	Не обов'язкове поле.
15	district	string	Район	Не обов'язкове поле.
16	city	string	Назва населеного пункту	Не обов'язкове поле.
17	street	string	Вулиця	Не обов'язкове поле.
18	street_number	string	Номер будинку	Не обов'язкове поле.
19	apartment	string	Квартира	Не обов'язкове поле.
20	bdate	date	день народження користувача	Не обов'язкове поле.
21	groupid	integer	група користувача	Не обов'язкове поле.	Ідентифікатор групи контактів в системі BOX
22	namelast	string	прізвище користувача	Не обов'язкове поле.
23	namemiddle	string	батькові користувача	Не обов'язкове поле.
24	source	string	Джерело користувача	Не обов'язкове поле.
25	typesex	string	підлогу користувача	Не обов'язкове поле.	За замовчуванням тип користувача - чоловік. Доступні типи користувачів: man - чоловік woman - жінка company - компанія
26	company	string	Компанія	Не обов'язкове поле.	Якщо їх кілька вказуємо через кому
27	companyid	integer	id компанії	Не обов'язкове поле.
28	distribution	boolean	Підписано контакт на розсилку	Не обов'язкове поле.
29	urls	string	веб-сайт контакту	Не обов'язкове поле.
30	image	string	аватар контакту	Не обов'язкове поле.
31	employer	boolean	Является ли контакт сотрудником	Не обов'язкове поле.
32	update	boolean	Оновлювати чи контактні дані	Не обов'язкове поле.	Приймає параметр 1 або 0, за замовчуванням 0. Якщо передати 1 то контактні дані (телефони і email-и) будуть оновлюватися, в іншому випадку якщо передати 0 то будуть допісиватся до сущесвуют
33	dataFromBody	boolean	Брати дані не з аргументів, а з body	Не обов'язкове поле.	Якщо переданий dataFromBody = 1, то дані будуть брати не з аргументів, а з тіла запиту. В тіло має бути переданий json, в якому ключами повинні бути параметри, описані вище. login і password пі цьому повинні посилаті як зазвичай

Видалення контакту, метод: /api/contact-delete/json/

Параметри

Приклад:

http://myboxurl/api/contact-delete/json/?login=LOGIN&password=PASSWORD&userid=666

№	Поле	Тип	Опис	Обов'язкове чи ні	Коментар
1	login	string	Логін в системі BOX	Обов'язкове поле.
2	password	string	Пароль в форматі md5	Обов'язкове поле.	Напишіть в техпідтримку і ми видамо вам hash для API
3	userid	integer	Ідентифікатор (ID OneBox) видаляється контакту	Не обов'язкове поле.
4	code1c	string	Ідентифікатор видаляється контакту з вашої системи (з вашого магазину)	Не обов'язкове поле.
5	mergeuserid	integer	Ідентифікатор (ID OneBox) контакту, з яким потрібно об'єднати видаляємий контакт	Не обов'язкове поле.
6	mergecode1c	string	Ідентифікатор контакту з вашої системи (з вашого магазину), з яким потрібно об'єднати видаляємий контакт	Не обов'язкове поле.

Перевірка активності клієнта за логіном або id, метод: /api/contact-login/status/json/

Параметри

Приклад:

http://myboxurl/api/contact-login/status/json/?login=LOGIN&password=PASSWORD&userid=666

№	Поле	Тип	Опис	Обов'язкове чи ні	Коментар
1	login	string	Логін в системі BOX	Обов'язкове поле.
2	password	string	Пароль в форматі md5	Обов'язкове поле.	Напишіть в техпідтримку і ми видамо вам hash для API
3	userid	integer	Ідентифікатор (ID OneBox) контакту	Або userid або userlogin контакту обов'язково	Значення повертаються полів id - id контакту, login - логін контакту, isonline - (true/false) статус, залягання користувач, lastactivity - дата і час останньої активності контакту, pultstatus - (work/pause/stop) статус пульта контакту
4	userlogin	string	Логін контакту в OneBox	Або userid або userlogin контакту обов'язково

Можливі варіанти відповіді на запит

Детальніше

№	Статус	Повідомлення	Опис повідомлення
1	ok	userid	id доданого / відредагованого користувача
2	fail	login_empty	Відсутня логін
3	fail	password_empty	Відсутня пароль
4	fail	Login or password not correct!	Невірний логін або пароль
5	fail	Bad user level!	Низький рівень користувача, для виконання даної дії (потрібен level 2 і вище)
6	fail	name_empty	Ім `я відсутнє
7	fail	email or phone is empty	email або телефон відсутні
8	fail	Payment by id or code1c not found	Платіж з таким id або кодом вже існує
9	fail	dublicate by code1c	Контакт з таким кодом вже існує
10	fail	Not found contact	У контактній знайдений
11	fail	User-object by code1c not found	Контакт з таким кодом не найден
12	fail	Phone is exists	Контакт з таким телефоном вже існує
13	fail	Email is exists	Контакт з таким email вже існує

Також можуть виникати помилки:

502 Bad Gateway - Якщо виникла ця помилка необхідно:
1. Перевірити, чи є доступ до Інтернету (зайти на будь-який інший сайт).
2. Якщо проблем з доступом немає — можна видалити файли cookies.
Якщо вказане вище не допомогло — проблема на стороні сервера. Слід звернутися до системного адміністратора сайту.

503 (Service Temporarily Unavailable) - дана помилка може виникати в результаті занадто великої кількості запитів до сервера. Якщо ви побачили таку помилку, варто почекати пару хвилин і спробувати знову.

504 Gateway Timeout - cкорее за все справа в зрослої навантаженні на сайт, при якій Apache не встигає віддавати HTTP-відповіді, і нові запити встають в чергу. Щоб вирішити проблему, можна додати ресурсів сервера, зокрема оперативної пам'яті, і збільшити кількість процесів httpd (Apache).
Інша можлива причина виникнення помилки 504 - виконуваний скрипт не вкладається у відведений ліміт часу. Це буває, коли запит занадто важкий. Спробуйте розбити свій запит на кілька більш маленьких.

Помилка 505 HTTP Version not supported означає, що веб-сайт не підтримує версію протоколу HTTP, за допомогою якого браузер здійснює запит веб-сторінки

API користувачі (User)

Параметри отримання одного контакту:

Параметри отримання всіх контактів:

Дякую за ваш вибір.