Различия

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

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

Предыдущая версия справа и слева Предыдущая версия
Следующая версия
Предыдущая версия
api [2019/08/23 17:06]
annasemukhina
api [2020/07/14 12:23] (текущий)
a.001 [• Дополнительные возможности API]
Строка 1: Строка 1:
 ====== API магазина на платформе АвтоВебОфис ====== ====== API магазина на платформе АвтоВебОфис ======
 ===== • Введение ===== ===== • Введение =====
 +
 +Пользователям АвтоВебОфис предоставлено несколько способов интеграции и обмена информацией с другими системами:​ API и [[sideservice|оповещения сторонних скриптов (вебхуки)]]. ​ \\ \\
 +API работает по системе запроса пользователя,​ т.е. инициатором выступаете Вы, есть 2 режима:​
 +    - GET (API KEY GET) - от Вас приходит запрос по API на получения данных,​ например,​ о созданном счете, и они Вам отсылаются массивом
 +    - SET (API KEY SET) - от Вас приходит запрос по API на внесение данных в нашу систему,​ например,​ создание или изменение счета в Вашем магазине АвтоВебОфис. ​
 +В сервисе действует гибкая система доступных ключей для работы с АПИ, для получения данных требуется ключ API KEY GET, для создания записей в системе требуется ключ API KEY SET. Посмотреть,​ какие ключи доступны на Вашем тарифе Вы можете [[https://​autoweboffice.com/#​price_api|тут]]. ​ \\ \\  ​
 +
 +Требуемые ключи находятся в разделе Настройки-API Вашего магазина {{ ::​безымянный_2_.jpg |}}  \\ \\  ​
 %%API%% сервиса АвтоВебОфис построен по REST-принципам. %%API%% сервиса АвтоВебОфис построен по REST-принципам.
  
Строка 175: Строка 183:
 ==== Перечень ресурсов,​ которые поддерживаются 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 - тип трафика \\ roistat - Роистат ​       |+^ Контакты ​ | ?​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 - тип трафика \\ vk_user_id - идентификатор vk контакта \\ 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 - код зарегистрировавшего сотрудника |
Строка 183: Строка 191:
 ^ Счета | ?​r=api/​rest/​accounts | GET \\ PUT \\ POST \\ DELETE | id_account - код счета \\ id_partner - код партнера \\ account_number - номер счета \\ account_sum - общая сумма счета \\ id_account_status - код статуса счета (1 - создан,​ 2 - отказ, 3 - в обработке,​ 4 - ошибка,​ 5 - оплачен)\\ close_account - признак закрытия счета \\ id_payment_system - код платежной системы \\ close_date - дата закрытия счета \\ date_of_order - дата создания счета \\ goods_return - признак возврата товара \\ date_of_payment - дата оплаты счета \\ goods_return_date - дата возврата товара \\ last_name - фамилия заказчика \\ name - имя заказчика \\ middle_name - отчестство заказчика \\ email - электронный адрес заказчика \\ phone_number - телефон заказчика \\ skype - skype заказчика \\ account_comment - комментарий к счету \\ id_organization - код организации \\ id_delivery_region - код региона доставки \\ id_delivery_region_method - код способа доставки для региона \\ id_country - код страны \\ area - область \\ city - город \\ delivery_address - адрес доставки \\ zip_code - почтовый индекс \\ barcode - почтовый идентификатор \\ id_employee_created - код создавшего сотрудника \\ id_advertising_channel_page - %%API%% код канала рекламы \\ advertising_channel_keyword - ключевое слово \\ advertising_channel_location - место размещения \\ advertising_channel_type_traffic - тип трафика\\ roistat - Роистат | ^ Счета | ?​r=api/​rest/​accounts | GET \\ PUT \\ POST \\ DELETE | id_account - код счета \\ id_partner - код партнера \\ account_number - номер счета \\ account_sum - общая сумма счета \\ id_account_status - код статуса счета (1 - создан,​ 2 - отказ, 3 - в обработке,​ 4 - ошибка,​ 5 - оплачен)\\ close_account - признак закрытия счета \\ id_payment_system - код платежной системы \\ close_date - дата закрытия счета \\ date_of_order - дата создания счета \\ goods_return - признак возврата товара \\ date_of_payment - дата оплаты счета \\ goods_return_date - дата возврата товара \\ last_name - фамилия заказчика \\ name - имя заказчика \\ middle_name - отчестство заказчика \\ email - электронный адрес заказчика \\ phone_number - телефон заказчика \\ skype - skype заказчика \\ account_comment - комментарий к счету \\ id_organization - код организации \\ id_delivery_region - код региона доставки \\ id_delivery_region_method - код способа доставки для региона \\ id_country - код страны \\ area - область \\ city - город \\ delivery_address - адрес доставки \\ zip_code - почтовый индекс \\ barcode - почтовый идентификатор \\ id_employee_created - код создавшего сотрудника \\ id_advertising_channel_page - %%API%% код канала рекламы \\ advertising_channel_keyword - ключевое слово \\ advertising_channel_location - место размещения \\ advertising_channel_type_traffic - тип трафика\\ roistat - Роистат |
 ^ Рекуррентные счета | ?​r=api/​rest/​ContactRecurringPayments | GET \\ PUT \\ POST \\ DELETE | id_contact_recurring_payments - уникальный идентификатор подписки контакта \\ id_contact - код контакта \\ id_goods - код товара по покупка которого привела к подписке \\ id_account_line - код строки счета \\ id_payment_system - код платежной системы \\ date_last_payments - дата последнего платежа \\ date_next_payments - дата следующего платежа \\ date_lock - дата блокировки \\ unsubscribe - признак отписки \\ recurring_payment_failed - признак НЕуспешного платежа по подписке (списание не удалось) \\ unsubscribe_date - дата отписки \\ creation_date - дата создания записи \\ deleted - признак удаления \\ deleted_date - дата удаления записи | ^ Рекуррентные счета | ?​r=api/​rest/​ContactRecurringPayments | GET \\ PUT \\ POST \\ DELETE | id_contact_recurring_payments - уникальный идентификатор подписки контакта \\ id_contact - код контакта \\ id_goods - код товара по покупка которого привела к подписке \\ id_account_line - код строки счета \\ id_payment_system - код платежной системы \\ date_last_payments - дата последнего платежа \\ date_next_payments - дата следующего платежа \\ date_lock - дата блокировки \\ unsubscribe - признак отписки \\ recurring_payment_failed - признак НЕуспешного платежа по подписке (списание не удалось) \\ unsubscribe_date - дата отписки \\ creation_date - дата создания записи \\ deleted - признак удаления \\ deleted_date - дата удаления записи |
-^ Товары | ?​r=api/​rest/​goods | GET \\ PUT \\ POST \\ DELETE | id_goods - код товара \\ marking - артикул товара \\ id_goods_category - код категории товаров \\ in_affiliate - признак участия в партнерской программе магазина \\ show_in_affiliate - признак отображения в партнерской программе магазина \\ goods - товар \\ variants_name - варианты названия \\ image - изображение \\ url_external_image - %%Url%% внешнего изображения \\ url_external_image_used - признак использования внешнего изображения \\ brief_description - краткое описание \\ price - цена \\ price_purchase - цена закупки \\ url_page - %%url%% страницы описания \\ not_sold - признак снятия в продажи \\ not_sold_message - сообщение выводимое если товар снят с продажи \\ new_of_sales - признак "​Новинка"​ \\ hit_of_sales - признак "​Хит продаж"​ \\ special_offer - признак "​Специальное предложение"​ \\ id_goods_kind - код вила товара \\ creation_date - дата создания \\ rest_in_stock - остаток товара на складе \\ id_supplier - код поставщика \\ id_manufacturer - код производителя \\ id_employee_created - код создавшего сотрудника \\ goods_color_name - название свойства "​Цвет товара"​ \\ goods_size_name - название свойства "​Размер товара"​ \\ goods_color_used - использовать свойства "​Цвет товара"​ \\ goods_size_used - использовать свойства "​Размер товара"​ \\ free_price - признак свободной цены \\ free_price_min - минимальная свободная цена \\ free_price_recommend - рекомендуемая свободная цена |+^ Товары | ?​r=api/​rest/​goods | GET \\ PUT \\ POST \\ DELETE | id_goods - код товара \\ marking - артикул товара \\ id_goods_category - код категории товаров \\ in_affiliate - признак участия в партнерской программе магазина \\ show_in_affiliate - признак отображения в партнерской программе магазина \\ goods - товар \\ variants_name - варианты названия \\ image - изображение \\ url_external_image - %%Url%% внешнего изображения \\ url_external_image_used - признак использования внешнего изображения \\ brief_description - краткое описание \\ price - цена \\ price_purchase - цена закупки \\ url_page - %%url%% страницы описания \\ not_sold - признак снятия в продажи \\ not_sold_message - сообщение выводимое если товар снят с продажи \\ new_of_sales - признак "​Новинка"​ \\ hit_of_sales - признак "​Хит продаж"​ \\ special_offer - признак "​Специальное предложение"​ \\ id_goods_kind - код вила товара \\ creation_date - дата создания \\ rest_in_stock - остаток товара на складе \\ id_supplier - код поставщика \\ id_manufacturer - код производителя \\ id_employee_created - код создавшего сотрудника \\ goods_color_name - название свойства "​Цвет товара"​ \\ goods_size_name - название свойства "​Размер товара"​ \\ goods_color_used - использовать свойства "​Цвет товара"​ \\ goods_size_used - использовать свойства "​Размер товара"​ \\ free_price - признак свободной цены \\ free_price_min - минимальная свободная цена \\ free_price_recommend - рекомендуемая свободная цена \\ id_currency - код валюты товара|
 ^ Категории \\ товаров | ?​r=api/​rest/​goodscategory | GET \\ PUT \\ POST \\ DELETE | id_goods_category - код категории товаров \\ goods_category - название \\ brief_description - краткое описание \\ id_goods_category_parent - код категории родителя \\ id_employee_created - код создавшего сотрудника \\ creation_date - дата создания | ^ Категории \\ товаров | ?​r=api/​rest/​goodscategory | GET \\ PUT \\ POST \\ DELETE | id_goods_category - код категории товаров \\ goods_category - название \\ brief_description - краткое описание \\ id_goods_category_parent - код категории родителя \\ id_employee_created - код создавшего сотрудника \\ creation_date - дата создания |
 ^ Цвет товара | ?​r=api/​rest/​goodscolor | GET \\ PUT \\ POST \\ DELETE | id_goods_color - код цвета товара \\ num - порядковый номер \\ goods_color - цвет товара \\ goods_color_hex - HEX-код цвета товара \\ change_price - настройка изменения цены для цвета товара \\ id_goods - код товара \\ used - признак "​Используется"​ \\ creation_date - дата создания \\ id_employee_created - код создавшего сотрудника | ^ Цвет товара | ?​r=api/​rest/​goodscolor | GET \\ PUT \\ POST \\ DELETE | id_goods_color - код цвета товара \\ num - порядковый номер \\ goods_color - цвет товара \\ goods_color_hex - HEX-код цвета товара \\ change_price - настройка изменения цены для цвета товара \\ id_goods - код товара \\ used - признак "​Используется"​ \\ creation_date - дата создания \\ id_employee_created - код создавшего сотрудника |
Строка 200: Строка 208:
 | Код вида товара | 1 - Электронная версия (Запись) \\ 2 - Физический товар \\ 3 - Услуга | | Код вида товара | 1 - Электронная версия (Запись) \\ 2 - Физический товар \\ 3 - Услуга |
 | Код статуса счета | 1 - Создан \\ 2 - Отказ \\ 3 - В обработке \\ 4 - Ошибка \\ 5 - Оплачен | | Код статуса счета | 1 - Создан \\ 2 - Отказ \\ 3 - В обработке \\ 4 - Ошибка \\ 5 - Оплачен |
 +| Код валюты товара | 987 - RUB (Рубли) \\ 980 - UAH (Гривны) \\ 978 - EUR (Евро) \\ 933 - BYN (Бел.рубли) \\ 840 - USD (Доллары) \\ 398 - KZT (Тенге) |
 | Код платежной системы (способа оплаты) | 1 - Яндекс.Деньги для физ. лиц \\ 2 - RBK Money \\ 3 - QIWI (QIWI Wallet) \\ 4 - Оплата через российский банк \\ 5 - Z-payment \\ 6 - WebMoney \\ 7 - LiqPay \\ 8 - InterKassa \\ 9 - Наличные \\ 12 - Юридическим лицам \\ 13 - Наложенный платеж \\ 14 - 2CheckOut \\ 15 - PayPal \\ 16 - ROBOKASSA \\ 17 - Яндекс.Деньги для юр. лиц (Яндекс.Касса) \\ 18 - Оплата через украинский Банк \\ 19 -  Единый кошелек (WalletOne) \\ 20 - Свой способ оплаты \\ 21 - PayOnline \\ 22 - IntellectMoney \\ 23 - PayMaster \\ 24 - PayAnyWay \\ 26 - Яндекс.Деньги перевод на банковский счет \\ 27 - Тинькофф Кредитные Системы | | Код платежной системы (способа оплаты) | 1 - Яндекс.Деньги для физ. лиц \\ 2 - RBK Money \\ 3 - QIWI (QIWI Wallet) \\ 4 - Оплата через российский банк \\ 5 - Z-payment \\ 6 - WebMoney \\ 7 - LiqPay \\ 8 - InterKassa \\ 9 - Наличные \\ 12 - Юридическим лицам \\ 13 - Наложенный платеж \\ 14 - 2CheckOut \\ 15 - PayPal \\ 16 - ROBOKASSA \\ 17 - Яндекс.Деньги для юр. лиц (Яндекс.Касса) \\ 18 - Оплата через украинский Банк \\ 19 -  Единый кошелек (WalletOne) \\ 20 - Свой способ оплаты \\ 21 - PayOnline \\ 22 - IntellectMoney \\ 23 - PayMaster \\ 24 - PayAnyWay \\ 26 - Яндекс.Деньги перевод на банковский счет \\ 27 - Тинькофф Кредитные Системы |
  
Строка 205: Строка 214:
 ^ Ресурс ^ %%URL%% ^ Методы ^ Параметры | ^ Ресурс ^ %%URL%% ^ Методы ^ Параметры |
 | Отправка email оповещения клиенту \\ о создании/​оплате существующего счета ​  | ?​r=api/​rest/​accountssendmail | GET | id - код счета (id_account) \\ key - %%API%% KEY SET | | Отправка email оповещения клиенту \\ о создании/​оплате существующего счета ​  | ?​r=api/​rest/​accountssendmail | GET | id - код счета (id_account) \\ key - %%API%% KEY SET |
 +| Получения персональной ссылки на оплату \\ товара (уникальная для контакта) \\ Контакт сразу попадает \\  на страницу выбора платежной системы,​ \\  минуя форму заполнения контактных данных ​   | ?​r=api/​rest/​geturlgoodsordering | GET | key - %%API%% KEY GET \\ id_goods - КОД_ТОВАРА \\ id_contact - КОД_КОНТАКТА \\ rp - для получения ссылки на оплату рекуррента (rp=1) |
 \\ \\ \\ \\
 Если у Вас еще остались какие-либо вопросы,​ пожалуйста,​ обращайтесь в нашу Службу поддержки через кнопку [[https://​autoweboffice.com/​support/​open.php|Обратиться в поддержку]],​ по email <​zakaz@autoweboffice.com>​ или в окне консультанта на сайте http://​autoweboffice.com Если у Вас еще остались какие-либо вопросы,​ пожалуйста,​ обращайтесь в нашу Службу поддержки через кнопку [[https://​autoweboffice.com/​support/​open.php|Обратиться в поддержку]],​ по email <​zakaz@autoweboffice.com>​ или в окне консультанта на сайте http://​autoweboffice.com
  
 \\  //​Успехов Вам и до новых встреч!//​ \\  //​Служба заботы о клиентах сервиса АвтоВебОфис//​ \\  //​Успехов Вам и до новых встреч!//​ \\  //​Служба заботы о клиентах сервиса АвтоВебОфис//​