Различия

Здесь показаны различия между двумя версиями данной страницы.

Ссылка на это сравнение

Предыдущая версия справа и слева Предыдущая версия
Следующая версия
Предыдущая версия
api [2018/03/20 13:21]
sergcherkashin
api [2019/07/11 11:17] (текущий)
annasemukhina
Строка 20: Строка 20:
  
 Для иллюстрации возможностей программного интерфейса в справочнике приведены [[api#​примеры_запросов|примеры]] обращения к магазину,​ зарегистрированному в сервисе АвтоВебОфис,​ посредством %%API%%. Методы в примерах возвращают демонстрационные данные,​ доступные для просмотра всем пользователям. Для иллюстрации возможностей программного интерфейса в справочнике приведены [[api#​примеры_запросов|примеры]] обращения к магазину,​ зарегистрированному в сервисе АвтоВебОфис,​ посредством %%API%%. Методы в примерах возвращают демонстрационные данные,​ доступные для просмотра всем пользователям.
 +
 +**ВНИМАНИЕ!** Для удобства работы с АПИ Вы можете использовать [[https://​github.com/​AutoWebOffice/​AwoApi|готовый класс на PHP]]
  
 ===== • Структура API ===== ===== • Структура API =====
Строка 173: Строка 175:
 ==== Перечень ресурсов,​ которые поддерживаются API АвтоВебОфис,​ и доступных для них операций. ==== ==== Перечень ресурсов,​ которые поддерживаются API АвтоВебОфис,​ и доступных для них операций. ====
 ^ Ресурс ​     ^ %%URL%% ​              ^ Методы ​          ^ Параметры ^ ^ Ресурс ​     ^ %%URL%% ​              ^ Методы ​          ^ Параметры ^
-^ Контакты ​ | ?​r=api/​rest/​contacts ​  | GET \\ PUT \\ POST \\ DELETE ​ | id_contact - код контакта \\ id_partner - код партнера \\ last_name - фамилия \\ name - имя \\ middle_name - отчество \\ email - адрес электронной почты \\ password - пароль от личного кабинета клиента \\ not_to_write - просил не писать \\ spam_clicked - пожаловался на СПАМ \\ spam_clicked_date - дата жалобы на спам \\ unsubscribe_date - дата отписки от новостей магазина \\ email_not_exist - признак не существования email \\ phone_number - номер телефона \\ do_not_call - просил не звонить \\ id_country - код страны \\ zip_code - почтовый индекс \\ area - область \\ city - город \\ delivery_address - адрес доставки \\ skype - skype клиента \\ ban - признак блокировки клиента \\ ban_reason - причина блокировки клиента \\ sex - пол (1 - муж., 2 - жен.) \\ date_of_birth - дата рождения \\ brief_description - краткое описание \\ date_registration - дата регистрации в системе \\ id_employee_responsible - код ответственного сотрудника \\ id_employee_created - код сотрудника,​ зарегистрировавшего контакт \\ id_advertising_channel_page - %%API%% код канала рекламы \\ advertising_channel_keyword - ключевое слово \\ advertising_channel_location - место размещения \\ advertising_channel_type_traffic - тип трафика ​       |+^ Контакты ​ | ?​r=api/​rest/​contacts ​  | GET \\ PUT \\ POST \\ DELETE ​ | id_contact - код контакта \\ id_partner - код партнера \\ last_name - фамилия \\ name - имя \\ middle_name - отчество \\ email - адрес электронной почты \\ password - пароль от личного кабинета клиента \\ not_to_write - просил не писать \\ spam_clicked - пожаловался на СПАМ \\ spam_clicked_date - дата жалобы на спам \\ unsubscribe_date - дата отписки от новостей магазина \\ email_not_exist - признак не существования email \\ phone_number - номер телефона \\ do_not_call - просил не звонить \\ id_country - код страны \\ zip_code - почтовый индекс \\ area - область \\ city - город \\ delivery_address - адрес доставки \\ skype - skype клиента \\ ban - признак блокировки клиента \\ ban_reason - причина блокировки клиента \\ sex - пол (1 - муж., 2 - жен.) \\ date_of_birth - дата рождения \\ brief_description - краткое описание \\ date_registration - дата регистрации в системе \\ id_employee_responsible - код ответственного сотрудника \\ id_employee_created - код сотрудника,​ зарегистрировавшего контакт \\ id_advertising_channel_page - %%API%% код канала рекламы \\ advertising_channel_keyword - ключевое слово \\ advertising_channel_location - место размещения \\ advertising_channel_type_traffic - тип трафика ​\\ roistat - Роистат ​       |
 ^ Организации | ?​r=api/​rest/​organization | GET \\ PUT \\ POST \\ DELETE | id_organization - код организации \\ organization - название \\ inn - ИНН \\ kpp - КПП \\ set_account - расчетный счет \\ bank - наименование банка \\ bik - БИК \\ pk - корсчет \\ creation_date - дата создания \\ id_employee_created - код сотрудника,​ создавшего организацию | ^ Организации | ?​r=api/​rest/​organization | GET \\ PUT \\ POST \\ DELETE | id_organization - код организации \\ organization - название \\ inn - ИНН \\ kpp - КПП \\ set_account - расчетный счет \\ bank - наименование банка \\ bik - БИК \\ pk - корсчет \\ creation_date - дата создания \\ id_employee_created - код сотрудника,​ создавшего организацию |
 ^ Сотрудники | ?​r=api/​rest/​employee | GET \\ PUT \\ POST \\ DELETE | id_employee - код сотрудника \\ employee - сотрудник \\ login - email сотрудника (логин) \\ id_contact - код контакта \\ ban - признак увольнения (блокировки) \\ temporary - признак "​временный сотрудник"​ \\ num_in_tracking - номер в менеджере задач \\ show_in_tracking - показывать или нет в менеджере задач \\ date_registration - дата регистрации \\ id_employee_created - код зарегистрировавшего сотрудника | ^ Сотрудники | ?​r=api/​rest/​employee | GET \\ PUT \\ POST \\ DELETE | id_employee - код сотрудника \\ employee - сотрудник \\ login - email сотрудника (логин) \\ id_contact - код контакта \\ ban - признак увольнения (блокировки) \\ temporary - признак "​временный сотрудник"​ \\ num_in_tracking - номер в менеджере задач \\ show_in_tracking - показывать или нет в менеджере задач \\ date_registration - дата регистрации \\ id_employee_created - код зарегистрировавшего сотрудника |