OneBox
OneBox Rest API
API Benutzer (Benutzer)

API Benutzer (Benutzer)

Hinzufügen eines Kontakts Methode: /api/contact-add/json/

Optionen

Beispiel:

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=Vatersname&namelast=Nachname&commentadmin=commentadmin&parentid=24&country=Land®ion=Region&district=Bereich&city=Stadt&street=Die Straße&street_number=Hausnummer&apartment=Wohnung&phone=80639350555&userpass=123456789A&code1c=code1c&pricelevel=Preis 1&customfield_key1=customvalue1&customfield_key2=2016-01-01

Es ist auch möglich, zusätzliche Kontaktfelder auszufüllen. Dazu wird der Bezeichner des Zusatzfeldes als Variable angegeben und die Werte typgleich zum angegebenen Feld übernommen

№	Feld	Art	Beschreibung	Obligatorisch oder nicht	Kommentar
1	login	string	Melden Sie sich im BOX-System an	Pflichtfeld.
2	password	string	Passwort im md5-Format	Pflichtfeld.	Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API
3	name	string	Benutzername	Nicht erforderliches Feld.
4	userlogin	string	Benutzer-Anmeldung	Nicht erforderliches Feld.
5	userpass	string	Benutzer-Passwort	Nicht erforderliches Feld.
6	email	string	email Benutzer	Pflichtfeld (entweder E-Mail oder Telefon muss sein).
7	phone	string	Benutzertelefon	Pflichtfeld (entweder E-Mail oder Telefon muss sein).
8	address	string	vollständige Benutzeradresse in einer Zeile (obsoleter Parameter)	Nicht erforderliches Feld.
9	country	string	Land	Nicht erforderliches Feld.
10	region	string	Region (Gebiet)	Nicht erforderliches Feld.
11	district	string	Bereich	Nicht erforderliches Feld.
12	city	string	Ortsname	Nicht erforderliches Feld.
13	street	string	Die Straße	Nicht erforderliches Feld.
14	street_number	string	Hausnummer	Nicht erforderliches Feld.
15	apartment	string	Wohnung	Nicht erforderliches Feld.
16	bdate	date	Geburtstag des Benutzers	Nicht erforderliches Feld.
17	parentid	integer	auf Empfehlung von	Nicht erforderliches Feld.
18	level	integer	Benutzerzugriffsebene	Nicht erforderliches Feld.	Zugriffsebenen: 0 - verstopft 1 - Klient 2 - Mitarbeiter 3 - Administrator
19	commentadmin	string	Admin-Kommentar	Nicht erforderliches Feld.
20	groupid	integer	Benutzergruppe	Nicht erforderliches Feld.	Kontaktgruppen-ID im BOX-System
21	source	integer	Benutzerquelle	Nicht erforderliches Feld.	Quell-ID im BOX-System
22	pricelevel	string	Benutzerpreisniveau	Nicht erforderliches Feld.	Der Name des Preises, den der Benutzer festlegen soll
23	distribution	boolean	Newsletter-Kontakt abonniert	Nicht erforderliches Feld.
24	tags	string	Stichworte	Nicht erforderliches Feld.
25	namelast	string	Nachname des Benutzers	Nicht erforderliches Feld.
26	namemiddle	string	zweiter Vorname des Benutzers	Nicht erforderliches Feld.
27	typesex	string	Benutzergeschlecht	Nicht erforderliches Feld.	Der Standardbenutzertyp ist männlich. Verfügbare Benutzertypen: man - Mann woman - Frau company - Unternehmen
28	company	string	Benutzerunternehmen	Nicht erforderliches Feld.
29	code1c	string	code1c Benutzer	Nicht erforderliches Feld.	id Benutzer aus Ihrem System
30	companyid	integer	id Benutzerunternehmen	Nicht erforderliches Feld.
31	companycode1c	integer	Unternehmenscode des externen Benutzers	Nicht erforderliches Feld.
32	emails	string	email-Benutzeroberfläche (optional)	Nicht erforderliches Feld.	Geben Sie mit einem Leerzeichen an (test@tset.ua dddd@ya.ru)
33	managerid	integer	id Manager von OneBox	Nicht erforderliches Feld.
34	managercode	string	code1c Manager von OneBox	Nicht erforderliches Feld.
35	employer	boolean	Является ли контакт сотрудником	Nicht erforderliches Feld.
36	phones	string	Benutzertelefone (optional)	Nicht erforderliches Feld.	Geben Sie mit einem Leerzeichen (380977777777 380500500550) ohne Leerzeichen in den Telefonen selbst an
37	dataFromBody	boolean	Nehmen Sie Daten nicht aus Argumenten, sondern aus dem Körper	Nicht erforderliches Feld.	Wenn dataFromBody=1 übergeben wird, werden die Daten nicht aus den Argumenten, sondern aus dem Request-Body genommen. Json muss an den Body übergeben werden, in dem die Schlüssel die oben beschriebenen Parameter sein müssen. login und Passwort sollten wie gewohnt gesendet werden
38	update	boolean	Aktualisieren Sie den Kontakt, wenn er über die Kontaktdaten gefunden wird	Nicht erforderliches Feld.
39	fullname	string	Полное фамилия имя отчество в одном поле	Nicht erforderliches Feld.	Если не указаны параметры name, namelast и namemiddle, они будут через пробел браться из fullname согласно формата в nameformat, если одна из частей ФИО отсутствует, необходимо в этом месте вставить еще один пробел
40	nameformat	string	Порядок расположения имени (f), фамилии (l) и отчества (m) в fullname	Nicht erforderliches Feld.	По умолчанию формат l-f-m, что означает порядок Фамилия Имя Отчество

Einen Kontakt bekommen und alle Kontakte bekommen, Methode: /api/contact-get/json/

Optionen

Optionen zum Empfangen eines einzelnen Kontakts:

Beispiel:

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

№	Feld	Art	Beschreibung	Obligatorisch oder nicht	Kommentar
1	login	string	Melden Sie sich im BOX-System an	Pflichtfeld.
2	password	string	Passwort im md5-Format	Pflichtfeld.	Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API
3	supplierhash	string	Verkäuferschlüssel	Nicht erforderliches Feld.	Verfügbar in der Kundenkarte, die der Kontakt des Lieferanten ist. Verfügbar mit Login und Passwort aus der System- und Zugriffsebene" Klient". Ermöglicht es Ihnen, den Zugriff auf den Empfang von Kontakten gemäß der Zuordnung eines zusätzlichen Kontaktfeldes mit einem Lieferantenschlüssel einzuschränken (siehe. Einstellungen" Kontrollen und Einzigartigkeit") oder Prozesskunden, wenn der Lieferant ein Lieferant von Prozessprodukten ist.
4	userid	integer	Kontakt-ID im BOX-System	Oder Benutzer-ID oder Code1c oder Benutzeranmeldung oder Telefon- oder E-Mail-Kontakt erforderlich	Feldwerte zurückgeben contactId - id Kontakt, contactNamefull - Name des Ansprechpartners, contactCode1c - 1C Kontaktcode, contactName - Kontaktname, contactNamelast - Nachname des Ansprechpartners contactNamemiddle - zweiter Vorname des Kontakts, contactCompany - Unternehmen kontaktieren, contactCompanyID - id Unternehmen kontaktieren, contactEmail - Hauptkontakt E-Mail, contactEmails - zusätzliche Kontakt-E-Mail, contactPhone - Hauptkontakt Telefon, contactPhones - zusätzliche Telefonnummern, contactAdress - vollständige Kontaktadresse (in einer Zeile), contactCountry - Kontaktland, contactRegion - Region (Gebiet), contactDistrict - Bereich, contactCity - Stadt, contactStreet - Die Straße, contactStreetNumber - Hausnummer, contactApartment - Wohnung Datensatz Formen vollständige Kontaktadresse [contactAdress] contactTypesex - Kontaktgeschlecht (nicht definiert, männlich, weiblich, Firma),, contactBirthdate - Geburtsdatum des Kontakts, contactGroupsArray - eine Liste mit IDs und Gruppennamen, zu denen der Kontakt gehört, contactManagerid - ID Kontaktmanager, contactCdate - Datum der Kontakterstellung, contactPost - Position (Fachgebiet) des Ansprechpartners, contactSourceid - ID Kontaktquelle, contactSourcename - Kontaktquelle, contactPricelevel - Kontaktpreisniveau, contactAuthorid - ID Autor kontaktieren, contactBonuses - Kontaktboni, contactCurrency - Kontaktwährung, customFieldArray - zusätzliche Felder des Kontakts (der Name des zusätzlichen.Kontaktfelder, in Wert - Wert), legalArray - Liste der rechtlichen Kontaktdaten, contactCommentadmin - Admin-Kommentar, contactCommentLast - Der letzte Kommentar zum Kontakt, hinzugefügt über den Notizblock
5	code1c	string	Kontakt-ID aus Ihrem System (aus Ihrem Geschäft)
6	phone	string	Kontakt-Telefon
7	email	string	Kontakt E-mail
8	userlogin	string	Kontakt-Login
9	showbonus	boolean	Kontaktboni anzeigen	Nicht erforderliches Feld.	Wenn der Parameterwert 1 ist, wird das Feld contactBonuses mit den Boni des Kontakts angezeigt
10	showbonushistory	boolean	Zeigen Sie den Verlauf der gesammelten Prämien des Kontakts an	Nicht erforderliches Feld.	Wenn der Parameterwert 1 ist, wird das Array contactBonusHistoryArray mit einer Liste der angesammelten Boni angezeigt
11	showbonusbycategory	boolean	Zeigt die Bonusanzahl des Kontakts nach Bonuskategorie an	Nicht erforderliches Feld.	Wenn der Parameterwert 1 ist, wird das Array contactBonusByCategoryArray mit einer Liste der Anzahl der Boni, aufgeschlüsselt nach Bonuskategorien, angezeigt
12	searchcustomfield	boolean	Поиск контакта по значению дополнительного поля контакта	Nicht erforderliches Feld.	Параметр передается в виде массива, где key - ключ поля, а value - его значение

Optionen zum Abrufen aller Kontakte:

Beispiel:

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

№	Feld	Art	Beschreibung	Obligatorisch oder nicht	Kommentar
1	login	string	Melden Sie sich im BOX-System an	Pflichtfeld.
2	password	string	Passwort im md5-Format	Pflichtfeld.	Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API
3	supplierhash	string	Verkäuferschlüssel	Nicht erforderliches Feld.	Verfügbar in der Kundenkarte, die der Kontakt des Lieferanten ist. Verfügbar mit Login und Passwort aus der System- und Zugriffsebene" Klient". Ermöglicht es Ihnen, den Zugriff auf den Empfang von Kontakten gemäß der Zuordnung eines zusätzlichen Kontaktfeldes mit einem Lieferantenschlüssel einzuschränken (siehe. Einstellungen" Kontrollen und Einzigartigkeit") oder Prozesskunden, wenn der Lieferant ein Lieferant von Prozessprodukten ist.
4	groupid	integer	id Gruppe, aus der Sie Benutzer abrufen möchten	Nicht erforderliches Feld.
5	udatefrom	datetime	Datum der Benutzeraktualisierung ab Datum im Format Ymd H:i:s	Nicht erforderliches Feld.
6	udateto	datetime	Datum der Benutzeraktualisierung bis heute im Format Ymd H:i:s	Nicht erforderliches Feld.
7	typesex	string	Kontaktart	Nicht erforderliches Feld.	Es ist notwendig, den Schlüssel der Kontakttypen (z. B. Firma) zu übergeben.
8	custom_[Schlüssel]	optional	Filtern nach zusätzlichen Kontaktfeldern	Nicht erforderliches Feld.
9	part	integer	Teil der Ware	Pflichtfeld.	API gibt bis zu 1000 Kontakte im 1. Teil aus, um die nächsten 1000 Produkte zu erhalten, dort 2 weitergeben (Teil 2 wird erhalten) und so weiter. Feldwerte zurückgeben contactId - id Kontakt, contactNamefull - Name des Ansprechpartners, contactCode1c - 1C Kontaktcode, contactName - Kontaktname, contactNamelast - Nachname des Ansprechpartners contactNamemiddle - zweiter Vorname des Kontakts, contactCompany - Unternehmen kontaktieren, contactCompanyID - id Unternehmen kontaktieren, contactEmail - Hauptkontakt E-Mail, contactEmails - zusätzliche Kontakt-E-Mail, contactPhone - Hauptkontakt Telefon, contactPhones - zusätzliche Telefonnummern, contactAdress - vollständige Kontaktadresse, contactCountry - Kontaktland, contactRegion - Region (Gebiet), contactDistrict - Bereich, contactCity - Stadt, contactStreet - Die Straße, contactStreetNumber - Hausnummer, contactApartment - Wohnung Datensatz Formen vollständige Kontaktadresse [contactAdress] contactTypesex - Kontaktgeschlecht (nicht definiert, männlich, weiblich, Firma), contactBirthdate - Geburtsdatum des Kontakts, contactGroupsArray - eine Liste mit IDs und Gruppennamen, zu denen der Kontakt gehört, contactManagerid - ID Kontaktmanager, contactCdate - Datum der Kontakterstellung, contactPost - Position (Fachgebiet) des Ansprechpartners, contactSourceid - ID Kontaktquelle, contactSourcename - Kontaktquelle, contactPricelevel - Kontaktpreisniveau, contactAuthorid - ID Autor kontaktieren, contactBonuses - Kontaktboni, contactCurrency - Kontaktwährung, customFieldArray - zusätzliche Felder des Kontakts (der Name des zusätzlichen.Kontaktfelder, in Wert - Wert) Das Filtern von Kontakten nach zurückgegebenen Feldern ist ebenfalls verfügbar.. Es ist notwendig, einen Parameter zu übergeben, der dem Namen der zurückgegebenen Variablen entspricht, und einen Wert zum Filtern nach dem Variablenfeld. Beispielsweise werden bei der Übergabe des Parameters contactCountry=Ukraine Kontakte herausgefiltert, bei denen das Land in der Adresse angegeben ist" Ukraine"
10	showbonus	boolean	Kontaktboni anzeigen	Nicht erforderliches Feld.	Wenn der Parameterwert 1 ist, wird das Feld contactBonuses mit den Boni des Kontakts angezeigt
11	showbonushistory	boolean	Zeigen Sie den Verlauf der gesammelten Prämien des Kontakts an	Nicht erforderliches Feld.	Wenn der Parameterwert 1 ist, wird das Array contactBonusHistoryArray mit einer Liste der angesammelten Boni angezeigt
12	showbonusbycategory	boolean	Zeigt die Bonusanzahl des Kontakts nach Bonuskategorie an	Nicht erforderliches Feld.	Wenn der Parameterwert 1 ist, wird das Array contactBonusByCategoryArray mit einer Liste der Anzahl der Boni, aufgeschlüsselt nach Bonuskategorien, angezeigt
13	getmultiple	boolean	Получить массив результатов поиска контактов с дополнительной фильтрацией	Nicht erforderliches Feld.	Данный параметр работает, если заполнен хотя бы один из параметров для поиска одного контакта userid, code1c, phone, email, userlogin, searchcustomfield

Bearbeiten eines Kontakts, Methode: /api/contact-update/json/

Optionen

Beispiel:

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

№	Feld	Art	Beschreibung	Obligatorisch oder nicht	Kommentar
1	login	string	Melden Sie sich im BOX-System an	Pflichtfeld.
2	password	string	Passwort im md5-Format	Pflichtfeld.	Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API
3	userid	integer	Oder es wird die Benutzer-ID oder der Code1c des Kontakts benötigt	Pflichtfeld.
4	code1c	string	Kontakt-ID aus Ihrem System (aus Ihrem Geschäft)	Nicht erforderliches Feld.
5	userlogin	string	Kontakt-Login	Nicht erforderliches Feld.
6	userpass	string	Kontaktpasswort	Nicht erforderliches Feld.
7	name	string	Benutzername	Nicht erforderliches Feld.
8	email	string	email Benutzer	Nicht erforderliches Feld.
9	emails	string	email-Benutzeroberfläche (optional)	Nicht erforderliches Feld.	Geben Sie mit einem Leerzeichen an (test@tset.ua dddd@ya.ru)
10	phone	string	Benutzertelefon	Nicht erforderliches Feld.
11	phones	string	Benutzertelefone (optional)	Nicht erforderliches Feld.
12	address	string	vollständige Benutzeradresse in einer Zeile (obsoleter Parameter)	Nicht erforderliches Feld.
13	country	string	Land	Nicht erforderliches Feld.
14	region	string	Region (Gebiet)	Nicht erforderliches Feld.
15	district	string	Bereich	Nicht erforderliches Feld.
16	city	string	Ortsname	Nicht erforderliches Feld.
17	street	string	Die Straße	Nicht erforderliches Feld.
18	street_number	string	Hausnummer	Nicht erforderliches Feld.
19	apartment	string	Wohnung	Nicht erforderliches Feld.
20	bdate	date	Geburtstag des Benutzers	Nicht erforderliches Feld.
21	groupid	integer	Benutzergruppe	Nicht erforderliches Feld.	Kontaktgruppen-ID im BOX-System
22	namelast	string	Nachname des Benutzers	Nicht erforderliches Feld.
23	namemiddle	string	zweiter Vorname des Benutzers	Nicht erforderliches Feld.
24	source	string	Benutzerquelle	Nicht erforderliches Feld.
25	typesex	string	Benutzergeschlecht	Nicht erforderliches Feld.	Der Standardbenutzertyp ist männlich. Verfügbare Benutzertypen: man - Mann woman - Frau company - Unternehmen
26	company	string	Unternehmen	Nicht erforderliches Feld.	Wenn es mehrere davon gibt, trennen Sie sie mit einem Komma
27	companyid	integer	id Unternehmen	Nicht erforderliches Feld.
28	distribution	boolean	Newsletter-Kontakt abonniert	Nicht erforderliches Feld.
29	urls	string	Kontakt-Website	Nicht erforderliches Feld.
30	image	string	Avatar kontaktieren	Nicht erforderliches Feld.
31	employer	boolean	Является ли контакт сотрудником	Nicht erforderliches Feld.
32	update	boolean	Ob Kontaktinformationen aktualisiert werden sollen	Nicht erforderliches Feld.	Akzeptiert Parameter 1 oder 0, Standard 0. Wenn Sie 1 übergeben, werden die Kontaktdaten (Telefone und E-Mails) aktualisiert. Wenn Sie andernfalls 0 übergeben, werden sie an die vorhandenen angehängt.
33	dataFromBody	boolean	Nehmen Sie Daten nicht aus Argumenten, sondern aus dem Körper	Nicht erforderliches Feld.	Wenn dataFromBody=1 übergeben wird, werden die Daten nicht aus den Argumenten, sondern aus dem Request-Body genommen. Json muss an den Body übergeben werden, in dem die Schlüssel die oben beschriebenen Parameter sein müssen. login und Passwort sollten wie gewohnt gesendet werden

Kontakt löschen Methode: /api/contact-delete/json/

Optionen

Beispiel:

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

№	Feld	Art	Beschreibung	Obligatorisch oder nicht	Kommentar
1	login	string	Melden Sie sich im BOX-System an	Pflichtfeld.
2	password	string	Passwort im md5-Format	Pflichtfeld.	Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API
3	userid	integer	ID (OneBox-ID) des zu löschenden Kontakts	Nicht erforderliches Feld.
4	code1c	string	ID des Kontakts, der aus Ihrem System (aus Ihrem Shop) entfernt werden soll	Nicht erforderliches Feld.
5	mergeuserid	integer	Identifikator (ID OneBox) des Kontakts, mit dem Sie den gelöschten Kontakt zusammenführen möchten	Nicht erforderliches Feld.
6	mergecode1c	string	Kontakt-ID aus Ihrem System (aus Ihrem Geschäft), mit der Sie den gelöschten Kontakt zusammenführen möchten	Nicht erforderliches Feld.

Überprüfen der Client-Aktivität nach Login oder ID, Methode: /api/contact-login/status/json/

Optionen

Beispiel:

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

№	Feld	Art	Beschreibung	Obligatorisch oder nicht	Kommentar
1	login	string	Melden Sie sich im BOX-System an	Pflichtfeld.
2	password	string	Passwort im md5-Format	Pflichtfeld.	Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API
3	userid	integer	ID (OneBox-ID) des Kontakts	Es wird entweder die Benutzer-ID oder das Benutzer-Login des Kontakts benötigt	Feldwerte zurückgeben id - id Kontakt, login - Kontakt-Login, isonline - (true/false) Status, ob der Benutzer eingeloggt ist, lastactivity - Datum und Uhrzeit der letzten Aktivität des Kontakts, pultstatus - (work/pause/stop) Konsolenstatus kontaktieren
4	userlogin	string	Kontaktanmeldung in OneBox

Mögliche Antworten auf die Anfrage

Mehr

№	Status	Nachricht	Nachrichtenbeschreibung
1	ok	userid	id Benutzer hinzugefügt/bearbeitet
2	fail	login_empty	Fehlende Anmeldung
3	fail	password_empty	Fehlendes Passwort
4	fail	Login or password not correct!	Falsches Login oder Passwort
5	fail	Bad user level!	Niedriges Benutzerlevel zum Ausführen dieser Aktion (benötigt Level 2 und höher)
6	fail	name_empty	Kein Name
7	fail	email or phone is empty	email oder kein Telefon
8	fail	Payment by id or code1c not found	Die Zahlung mit dieser ID oder diesem Code ist bereits vorhanden
9	fail	dublicate by code1c	Kontakt mit diesem Code besteht bereits
10	fail	Not found contact	Kontakt nicht gefunden
11	fail	User-object by code1c not found	Kein Kontakt mit diesem Code gefunden
12	fail	Phone is exists	Kontakt mit diesem Telefon besteht bereits
13	fail	Email is exists	Kontakt mit dieser E-Mail besteht bereits

Es können auch Fehler auftreten:

502 Bad Gateway - Wenn dieser Fehler auftritt, müssen Sie:
1. Überprüfen Sie, ob Sie Zugang zum Internet haben (gehen Sie zu einer anderen Website).
2. Wenn es keine Probleme mit dem Zugriff gibt — Sie können Cookies löschen.
Wenn das oben genannte nicht geholfen hat — Serverseitiges Problem. Wenden Sie sich an den Systemadministrator der Site.

503 (Service Temporarily Unavailable) - Dieser Fehler kann durch zu viele auftreten Anfragen an den Server. Wenn Sie einen solchen Fehler sehen, sollten Sie ein paar Minuten warten und es erneut versuchen.

504 Gateway Timeout - cDer Punkt ist höchstwahrscheinlich die erhöhte Auslastung der Site, bei der Apache dies nicht tut verwaltet, HTTP-Antworten zu geben, und neue Anforderungen werden in die Warteschlange gestellt. Um das Problem zu lösen, können Sie hinzufügen Serverressourcen, insbesondere RAM, und die Anzahl der httpd-Prozesse erhöhen (Apache).
Ein weiterer möglicher Grund für den 504-Fehler ist, dass das ausführbare Skript nicht in das zugewiesene Limit passt Zeit. Dies passiert, wenn die Anfrage zu schwer ist. Versuchen Sie, Ihre Anfrage in mehrere weitere aufzuteilen klein.

Fehler 505 HTTP-Version wird nicht unterstützt bedeutet, dass die Website nicht ist unterstützt die Version des HTTP-Protokolls, die der Browser verwendet, um eine Webseite anzufordern

API Benutzer (Benutzer)

Optionen zum Empfangen eines einzelnen Kontakts:

Optionen zum Abrufen aller Kontakte:

Vielen Dank für Ihre Wahl.