OneBox
OneBox Rest API
API użytkownicy

API użytkownicy

Dodawanie kontaktu, metoda: /api/contact-add/json/

Opcje

Przykład:

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=nazwisko&namelast=nazwisko&commentadmin=commentadmin&parentid=24&country=Kraj®ion=region&district=Obszar&city=miasto&street=Ulica&street_number=numer domu&apartment=Apartament&phone=80639350555&userpass=123456789A&code1c=code1c&pricelevel=Cena 1&customfield_key1=customvalue1&customfield_key2=2016-01-01

Możliwe jest także wypełnienie dodatkowych pól kontaktowych. Aby to zrobić, identyfikator dodatkowego pola jest podawany jako zmienna, a wartości są akceptowane z tymi samymi typami, co określone pole

№	Pole	Typ	Opis	Obowiązkowe lub nie	Komentarz
1	login	string	Zaloguj się w systemie BOX	Pole obowiązkowe.
2	password	string	Hasło w formacie md5	Pole obowiązkowe.	Napisz do pomocy technicznej, a my przekażemy Ci hash dla API
3	name	string	Nazwa użytkownika	Pole nie wymagane.
4	userlogin	string	login użytkownika	Pole nie wymagane.
5	userpass	string	hasło użytkownika	Pole nie wymagane.
6	email	string	email użytkownik	Pole wymagane (musi być e-mail lub numer telefonu).
7	phone	string	telefon użytkownika	Pole wymagane (musi być e-mail lub numer telefonu).
8	address	string	pełny adres użytkownika w jednej linii (opcja przestarzała)	Pole nie wymagane.
9	country	string	Kraj	Pole nie wymagane.
10	region	string	Region (obszar)	Pole nie wymagane.
11	district	string	Obszar	Pole nie wymagane.
12	city	string	Nazwa miejscowości	Pole nie wymagane.
13	street	string	Ulica	Pole nie wymagane.
14	street_number	string	numer domu	Pole nie wymagane.
15	apartment	string	Apartament	Pole nie wymagane.
16	bdate	date	urodziny użytkownika	Pole nie wymagane.
17	parentid	integer	na polecenie od	Pole nie wymagane.
18	level	integer	poziom dostępu użytkownika	Pole nie wymagane.	Poziomy dostępu: 0 - zablokowany 1 - klient 2 - Pracownik 3 - Administrator
19	commentadmin	string	komentarz administratora	Pole nie wymagane.
20	groupid	integer	grupa użytkowników	Pole nie wymagane.	Identyfikator grupy kontaktowej w systemie BOX
21	source	integer	Źródło użytkownika	Pole nie wymagane.	Identyfikator źródła w systemie BOX
22	pricelevel	string	poziom cen użytkownika	Pole nie wymagane.	Nazwa ceny, którą chcesz ustawić dla użytkownika
23	distribution	boolean	Kontakt zapisany do newslettera	Pole nie wymagane.
24	tags	string	Tagi	Pole nie wymagane.
25	namelast	string	nazwisko użytkownika	Pole nie wymagane.
26	namemiddle	string	drugie imię użytkownika	Pole nie wymagane.
27	typesex	string	płeć użytkownika	Pole nie wymagane.	Domyślny typ użytkownika to mężczyzna. Dostępne typy użytkowników: man - Człowiek woman - kobieta company - firma
28	company	string	firma użytkownika	Pole nie wymagane.
29	code1c	string	code1c użytkownik	Pole nie wymagane.	id użytkownika z Twojego systemu
30	companyid	integer	id firma użytkownika	Pole nie wymagane.
31	companycode1c	integer	zewnętrzny kod firmy użytkownika	Pole nie wymagane.
32	emails	string	email-Użytkownicy (dodatkowi)	Pole nie wymagane.	Określ oddzielone spacją (test@tset.ua dddd@ya.ru)
33	managerid	integer	id menedżer z OneBox	Pole nie wymagane.
34	managercode	string	code1c menedżer z OneBox	Pole nie wymagane.
35	employer	boolean	Является ли контакт сотрудником	Pole nie wymagane.
36	phones	string	telefony użytkowników (dodatkowe)	Pole nie wymagane.	Wskaż oddzielone spacją (380977777777 380500500550) bez spacji w samych telefonach
37	dataFromBody	boolean	Pobieraj dane nie z argumentów, ale z treści	Pole nie wymagane.	Jeżeli zostanie przekazane dataFromBody=1, to dane zostaną pobrane nie z argumentów, ale z treści żądania. Należy przekazać treść json, w której klucze muszą mieć parametry opisane powyżej. login i hasło powinny zostać wysłane jak zwykle
38	update	boolean	Zaktualizuj kontakt, jeśli zostanie znaleziony przy użyciu informacji kontaktowych	Pole nie wymagane.
39	fullname	string	Полное фамилия имя отчество в одном поле	Pole nie wymagane.	Если не указаны параметры name, namelast и namemiddle, они будут через пробел браться из fullname согласно формата в nameformat, если одна из частей ФИО отсутствует, необходимо в этом месте вставить еще один пробел
40	nameformat	string	Порядок расположения имени (f), фамилии (l) и отчества (m) в fullname	Pole nie wymagane.	По умолчанию формат l-f-m, что означает порядок Фамилия Имя Отчество

Pobieranie jednego kontaktu i pobieranie wszystkich kontaktów, metoda: /api/contact-get/json/

Opcje

Opcje odbioru jednego kontaktu:

Przykład:

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

№	Pole	Typ	Opis	Obowiązkowe lub nie	Komentarz
1	login	string	Zaloguj się w systemie BOX	Pole obowiązkowe.
2	password	string	Hasło w formacie md5	Pole obowiązkowe.	Napisz do pomocy technicznej, a my przekażemy Ci hash dla API
3	supplierhash	string	Klucz dostawcy	Pole nie wymagane.	Dostępne w karcie klienta, która jest kontaktem dostawcy. Dostępne z loginem systemowym i hasłem oraz poziomem dostępu" klient". Umożliwia ograniczenie dostępu do odbierania kontaktów zgodnie z powiązaniem dodatkowego pola kontaktu z kluczem dostawcy (patrz. Ustawienia" Walidacje i wyjątkowość") lub klientów procesów, w przypadku których dostawca jest dostawcą produktów procesu.
4	userid	integer	Contact ID w systemie BOX	Lub wymagany jest identyfikator użytkownika lub kod 1c, login użytkownika, telefon lub adres e-mail kontaktu	Zwróć wartości pól contactId - id kontakt, contactNamefull - Nazwa Kontaktu, contactCode1c - Kod kontaktowy 1C, contactName - Nazwa Kontaktu, contactNamelast - nazwisko kontaktu, contactNamemiddle - drugie imię kontaktu, contactCompany - firma kontaktowa, contactCompanyID - id firma kontaktowa, contactEmail - główny adres e-mail kontaktowy, contactEmails - dodatkowe adresy e-mail kontaktowe, contactPhone - główny numer telefonu kontaktowego, contactPhones - dodatkowe numery kontaktowe, contactAdress - pełny adres kontaktowy (jedna linia), contactCountry - kraj kontaktu, contactRegion - Region (obszar), contactDistrict - Obszar, contactCity - miasto, contactStreet - Ulica, contactStreetNumber - numer domu, contactApartment - Apartament Zbiór danych formy pełny adres kontaktowy [contactAdress] contactTypesex - płeć kontaktu (nieokreślona, mężczyzna, kobieta, firma),, contactBirthdate - data urodzenia kontaktu, contactGroupsArray - listę identyfikatorów i nazw grup, do których należy kontakt, contactManagerid - ID menadżer kontaktów, contactCdate - data utworzenia kontaktu, contactPost - stanowisko (specjalizacja) kontaktu, contactSourceid - ID źródło kontaktu contactSourcename - źródło kontaktu, contactPricelevel - kontaktowy poziom cen, contactAuthorid - ID skontaktuj się z autorem, contactBonuses - bonusy za kontakt, contactCurrency - waluta kontaktowa, customFieldArray - dodatkowe pola kontaktowe (nazwa dodatkowego kontaktu przekazywana jest jako klucz.pola kontaktowe, w wartości - wartość), legalArray - lista prawnych danych kontaktowych, contactCommentadmin - komentarz administratora, contactCommentLast - Ostatni komentarz do kontaktu dodany poprzez blok notatek
5	code1c	string	Contact ID z Twojego systemu (z Twojego sklepu)
6	phone	string	Telefoniczny numer kontaktowy
7	email	string	Adres e-mail do kontaktu
8	userlogin	string	Zaloguj się do kontaktu
9	showbonus	boolean	Pokaż bonusy za kontakt	Pole nie wymagane.	Po podaniu wartości parametru 1 zostanie wyświetlone pole contactBonuses z bonusami kontaktowymi
10	showbonushistory	boolean	Wyświetl historię naliczania premii kontaktu	Pole nie wymagane.	W przypadku podania wartości parametru 1 zostanie wyświetlona tablica contactBonusHistoryArray z listą naliczonych bonusów
11	showbonusbycategory	boolean	Wyświetl liczbę bonusów kontaktowych według kategorii bonusów	Pole nie wymagane.	Po podaniu wartości parametru 1 zostanie wyświetlona tablica contactBonusByCategoryArray zawierająca listę ilości bonusów podzieloną według kategorii bonusów
12	searchcustomfield	boolean	Поиск контакта по значению дополнительного поля контакта	Pole nie wymagane.	Параметр передается в виде массива, где key - ключ поля, а value - его значение

Opcje pobierania wszystkich kontaktów:

Przykład:

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

№	Pole	Typ	Opis	Obowiązkowe lub nie	Komentarz
1	login	string	Zaloguj się w systemie BOX	Pole obowiązkowe.
2	password	string	Hasło w formacie md5	Pole obowiązkowe.	Napisz do pomocy technicznej, a my przekażemy Ci hash dla API
3	supplierhash	string	Klucz dostawcy	Pole nie wymagane.	Dostępne w karcie klienta, która jest kontaktem dostawcy. Dostępne z loginem systemowym i hasłem oraz poziomem dostępu" klient". Umożliwia ograniczenie dostępu do odbierania kontaktów zgodnie z powiązaniem dodatkowego pola kontaktu z kluczem dostawcy (patrz. Ustawienia" Walidacje i wyjątkowość") lub klientów procesów, w przypadku których dostawca jest dostawcą produktów procesu.
4	groupid	integer	id grupę, z której chcesz pozyskać użytkowników	Pole nie wymagane.
5	udatefrom	datetime	data aktualizacji użytkownika data początkowa w formacie Ymd H:i:s	Pole nie wymagane.
6	udateto	datetime	data aktualizacji użytkownika do chwili obecnej w formacie Ymd H:i:s	Pole nie wymagane.
7	typesex	string	Typ kontaktu	Pole nie wymagane.	Konieczne jest przeniesienie klucza typu kontaktu (na przykład firma)
8	custom_[klucz]	optional	Filtrowanie według dodatkowych pól kontaktowych	Pole nie wymagane.
9	part	integer	Część towaru	Pole obowiązkowe.	API daje do 1000 kontaktów w pierwszej części, aby otrzymać kolejne 1000 produktów przenieś tam 2 (otrzymujesz część 2) i tak dalej. Zwróć wartości pól contactId - id kontakt, contactNamefull - Nazwa Kontaktu, contactCode1c - Kod kontaktowy 1C, contactName - Nazwa Kontaktu, contactNamelast - nazwisko kontaktu, contactNamemiddle - drugie imię kontaktu, contactCompany - firma kontaktowa, contactCompanyID - id firma kontaktowa, contactEmail - główny adres e-mail kontaktowy, contactEmails - dodatkowe adresy e-mail kontaktowe, contactPhone - główny numer telefonu kontaktowego, contactPhones - dodatkowe numery kontaktowe, contactAdress - pełny adres kontaktowy, contactCountry - kraj kontaktu, contactRegion - Region (obszar), contactDistrict - Obszar, contactCity - miasto, contactStreet - Ulica, contactStreetNumber - numer domu, contactApartment - Apartament Zbiór danych formy pełny adres kontaktowy [contactAdress] contactTypesex - płeć kontaktu (nieokreślona, mężczyzna, kobieta, firma), contactBirthdate - data urodzenia kontaktu, contactGroupsArray - listę identyfikatorów i nazw grup, do których należy kontakt, contactManagerid - ID menadżer kontaktów, contactCdate - data utworzenia kontaktu, contactPost - stanowisko (specjalizacja) kontaktu, contactSourceid - ID źródło kontaktu contactSourcename - źródło kontaktu, contactPricelevel - kontaktowy poziom cen, contactAuthorid - ID skontaktuj się z autorem, contactBonuses - bonusy za kontakt, contactCurrency - waluta kontaktowa, customFieldArray - dodatkowe pola kontaktowe (nazwa dodatkowego kontaktu przekazywana jest jako klucz.pola kontaktowe, w wartości - wartość) Dostępne jest również filtrowanie kontaktów według zwróconych pól. Konieczne jest przekazanie parametru równego nazwie zwracanej zmiennej i wartości do filtrowania według pola zmiennej. Przykładowo przy przekazywaniu parametru contactCountry=Ukraine kontakty, których adres wskazuje na kraj, zostaną odfiltrowane" Ukraina"
10	showbonus	boolean	Pokaż bonusy za kontakt	Pole nie wymagane.	Po podaniu wartości parametru 1 zostanie wyświetlone pole contactBonuses z bonusami kontaktowymi
11	showbonushistory	boolean	Wyświetl historię naliczania premii kontaktu	Pole nie wymagane.	W przypadku podania wartości parametru 1 zostanie wyświetlona tablica contactBonusHistoryArray z listą naliczonych bonusów
12	showbonusbycategory	boolean	Wyświetl liczbę bonusów kontaktowych według kategorii bonusów	Pole nie wymagane.	Po podaniu wartości parametru 1 zostanie wyświetlona tablica contactBonusByCategoryArray zawierająca listę ilości bonusów podzieloną według kategorii bonusów
13	getmultiple	boolean	Получить массив результатов поиска контактов с дополнительной фильтрацией	Pole nie wymagane.	Данный параметр работает, если заполнен хотя бы один из параметров для поиска одного контакта userid, code1c, phone, email, userlogin, searchcustomfield

Edycja kontaktu, metoda: /api/contact-update/json/

Opcje

Przykład:

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

№	Pole	Typ	Opis	Obowiązkowe lub nie	Komentarz
1	login	string	Zaloguj się w systemie BOX	Pole obowiązkowe.
2	password	string	Hasło w formacie md5	Pole obowiązkowe.	Napisz do pomocy technicznej, a my przekażemy Ci hash dla API
3	userid	integer	Wymagany jest identyfikator użytkownika lub kod 1c kontaktu	Pole obowiązkowe.
4	code1c	string	Contact ID z Twojego systemu (z Twojego sklepu)	Pole nie wymagane.
5	userlogin	string	Zaloguj się do kontaktu	Pole nie wymagane.
6	userpass	string	Hasło kontaktu	Pole nie wymagane.
7	name	string	Nazwa użytkownika	Pole nie wymagane.
8	email	string	email użytkownik	Pole nie wymagane.
9	emails	string	email-Użytkownicy (dodatkowi)	Pole nie wymagane.	Określ oddzielone spacją (test@tset.ua dddd@ya.ru)
10	phone	string	telefon użytkownika	Pole nie wymagane.
11	phones	string	telefony użytkowników (dodatkowe)	Pole nie wymagane.
12	address	string	pełny adres użytkownika w jednej linii (opcja przestarzała)	Pole nie wymagane.
13	country	string	Kraj	Pole nie wymagane.
14	region	string	Region (obszar)	Pole nie wymagane.
15	district	string	Obszar	Pole nie wymagane.
16	city	string	Nazwa miejscowości	Pole nie wymagane.
17	street	string	Ulica	Pole nie wymagane.
18	street_number	string	numer domu	Pole nie wymagane.
19	apartment	string	Apartament	Pole nie wymagane.
20	bdate	date	urodziny użytkownika	Pole nie wymagane.
21	groupid	integer	grupa użytkowników	Pole nie wymagane.	Identyfikator grupy kontaktowej w systemie BOX
22	namelast	string	nazwisko użytkownika	Pole nie wymagane.
23	namemiddle	string	drugie imię użytkownika	Pole nie wymagane.
24	source	string	Źródło użytkownika	Pole nie wymagane.
25	typesex	string	płeć użytkownika	Pole nie wymagane.	Domyślny typ użytkownika to mężczyzna. Dostępne typy użytkowników: man - Człowiek woman - kobieta company - firma
26	company	string	Firma	Pole nie wymagane.	Jeżeli jest ich kilka, oznaczamy je oddzielonymi przecinkami
27	companyid	integer	id firmy	Pole nie wymagane.
28	distribution	boolean	Kontakt zapisany do newslettera	Pole nie wymagane.
29	urls	string	strona kontaktowa	Pole nie wymagane.
30	image	string	awatar kontaktu	Pole nie wymagane.
31	employer	boolean	Является ли контакт сотрудником	Pole nie wymagane.
32	update	boolean	Czy aktualizować informacje kontaktowe	Pole nie wymagane.	Akceptuje parametr 1 lub 0, domyślnie 0. Jeśli zdasz 1, dane kontaktowe (telefony i e-maile) zostaną zaktualizowane, w przeciwnym razie, jeśli zdasz 0, zostaną dodane do istniejących
33	dataFromBody	boolean	Pobieraj dane nie z argumentów, ale z treści	Pole nie wymagane.	Jeżeli zostanie przekazane dataFromBody=1, to dane zostaną pobrane nie z argumentów, ale z treści żądania. Należy przekazać treść json, w której klucze muszą mieć parametry opisane powyżej. login i hasło powinny zostać wysłane jak zwykle

Usuwanie kontaktu metoda: /api/contact-delete/json/

Opcje

Przykład:

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

№	Pole	Typ	Opis	Obowiązkowe lub nie	Komentarz
1	login	string	Zaloguj się w systemie BOX	Pole obowiązkowe.
2	password	string	Hasło w formacie md5	Pole obowiązkowe.	Napisz do pomocy technicznej, a my przekażemy Ci hash dla API
3	userid	integer	Identyfikator (ID OneBox) kontaktu, który ma zostać usunięty	Pole nie wymagane.
4	code1c	string	Identyfikator kontaktu, który chcesz usunąć z Twojego systemu (z Twojego sklepu)	Pole nie wymagane.
5	mergeuserid	integer	Identyfikator (ID OneBox) kontaktu, z którym należy połączyć usunięty kontakt	Pole nie wymagane.
6	mergecode1c	string	Identyfikator kontaktu z Twojego systemu (ze sklepu), z którym chcesz połączyć usunięty kontakt	Pole nie wymagane.

Sprawdzanie aktywności klienta po loginie lub identyfikatorze, metoda: /api/contact-login/status/json/

Opcje

Przykład:

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

№	Pole	Typ	Opis	Obowiązkowe lub nie	Komentarz
1	login	string	Zaloguj się w systemie BOX	Pole obowiązkowe.
2	password	string	Hasło w formacie md5	Pole obowiązkowe.	Napisz do pomocy technicznej, a my przekażemy Ci hash dla API
3	userid	integer	Identyfikator (ID OneBox) kontaktu	Wymagany jest identyfikator użytkownika lub login użytkownika kontaktu	Zwróć wartości pól id - id kontakt, login - kontakt zaloguj się, isonline - (true/false) status, czy użytkownik jest zalogowany, lastactivity - data i godzina ostatniej aktywności kontaktu, pultstatus - (work/pause/stop) skontaktuj się ze zdalnym statusem
4	userlogin	string	Logowanie do kontaktu w OneBox

Możliwe odpowiedzi na zapytanie

Więcej szczegółów

№	Status	Wiadomość	Opis wiadomości
1	ok	userid	id dodany/edytowany użytkownik
2	fail	login_empty	Brak logowania
3	fail	password_empty	Brak hasła
4	fail	Login or password not correct!	Nieprawidłowy login lub hasło
5	fail	Bad user level!	Niski poziom użytkownika, aby wykonać tę akcję (wymagany poziom 2 lub wyższy)
6	fail	name_empty	Bez nazwy
7	fail	email or phone is empty	email lub brakuje numeru telefonu
8	fail	Payment by id or code1c not found	Płatność o tym samym identyfikatorze lub kodzie już istnieje
9	fail	dublicate by code1c	Kontakt o tym samym kodzie już istnieje
10	fail	Not found contact	Nie znaleziono kontaktu
11	fail	User-object by code1c not found	Nie znaleziono kontaktu z tym kodem
12	fail	Phone is exists	Kontakt z takim telefonem już istnieje
13	fail	Email is exists	Kontakt o tym samym adresie e-mail już istnieje

Mogą również wystąpić błędy:

502 Bad Gateway - Jeśli wystąpi ten błąd, musisz to zrobić:
1. Sprawdź, czy jest dostęp do Internetu (przejdź do dowolnej innej witryny).
2. Jeśli nie ma problemów z dostępem — możesz usunąć pliki cookie.
Jeśli powyższe nie pomogło — problem po stronie serwera. Powinieneś skontaktować się z administratorem systemu lokacji.

503 (Service Temporarily Unavailable) - Ten błąd może wystąpić w wyniku zbyt dużej liczby żądania do serwera. Jeśli widzisz ten błąd, odczekaj kilka minut i spróbuj ponownie.

504 Gateway Timeout - cNajprawdopodobniej jest to spowodowane zwiększonym obciążeniem witryny, pod którym Apache nie jest w stanie zarządza wysyłaniem odpowiedzi HTTP, a nowe żądania ustawiają się w kolejce. Aby rozwiązać problem, możesz dodać zasobów serwera, w szczególności pamięci RAM, oraz zwiększenia liczby procesów httpd (Apache).
Inną możliwą przyczyną błędu 504 jest to, że wykonywany skrypt nie mieści się w wyznaczonym limicie. czas. Dzieje się tak, gdy żądanie jest zbyt ciężkie. Spróbuj podzielić żądanie na kilka kolejnych maluchy.

Błąd 505 Wersja HTTP nie jest obsługiwana oznacza, że strona internetowa nie jest obsługuje wersję protokołu HTTP używaną przez przeglądarkę do żądania strony internetowej

API użytkownicy

Opcje odbioru jednego kontaktu:

Opcje pobierania wszystkich kontaktów:

Dziękujemy za wybór.