apix

Схема взаимодействия стороннего программного обеспечения с сервисом API сайта
www.site.com
Сервис API отвечает на HTTP-запросы, отправляемые методом GET. Для каждого случая
взаимодействия предусмотрен свой адрес запроса.
Если Ваш интернет-магазин снабжен корзиной товаров, то непосредственно перед помещением
товара в корзину необходимо производить проверку наличия товара на нашем складе, и в
случае отсутствия товара уведомлять об этом пользователя. Также необходимо отправлять
запрос на проверку наличия товаров непосредственно перед отправкой запроса
на формирование заказа, в случае если в отправленном заказе будут присутствовать товары,
которых уже нет на складе, в HTTP ответа будет указана ошибка. В таком случае рекомендуется
уведомить пользователя, для того чтобы он отредактировал корзину либо сообщить ему о
невозможности формирования заказа.
Если заказ был успешно принят, то API вернет соответствующий статус и код сформированного
заказа.
В случае нулевого или отрицательного баланса, заказы не оформляются, а в HTTP ответа будет
возвращена ошибка.
Внимание!
При передаче параметра Код_1С (или id) указывайте его в точности так, как он получен из
файла CSV (или XML) со всеми лидирующими нулями!
Проверка наличия товаров на складе
URL для запроса HTTP GET:
http://www.site.com/api/check_available_many
Параметры запроса:
partner_id - код клиента (Ваш код - 3731)
id - массив кодов товаров (колонка код_1С из выгрузки в формате CSV либо id из выгрузки в формате
XML) (пример: id[]=111222 id[]=111333 id[]=111444)
md5 - md5 от строки получаемой слиянием строк: <кода партнера> <пароль партнера>
Ответ:
Набор строк, разделенных переводом строки, в каждой строке указывается свободное количество
товара на складе, либо , если товар с таким кодом не найден, то строка not found.
Пример:
http://www.site.com/api/check_available_many?id[]=111222&id[]=111333&id[]=111444&partner_id=1&md5
=dac659ec1b366c9916c0cf3ec61962b8
Формирование заказа
URL запроса HTTP GET:
http://www.site.com/api/order
Параметры запроса:
sum - наложенный платеж, который должен оплатить Ваш покупатель за заказ (сумма всех позиций в
заказе по Вашим розничным ценам плюс стоимость доставки если она взимается Вами)
partner_id - код клиента (Ваш код - 3731)
site - доменное имя сайта (необязательный параметр, если указан, то сайт должен быть указан в
кабинете в разделе сайты)
name - имя покупателя
surname - фамилия покупателя
fathername - отчество покупателя
phone - телефон покупателя
email - email покупателя
zip - почтовый индекс
region - регион (область, край, республика)
city - город
street - улица
house - дом
building - строение
corps - корпус
flat - квартира
items - массив товаров, в формате
array (
0 : array ( код_товара, количество),
1 : array( код_товара, количество),
2 : ...
)
delivery - способ доставки: 1 - Курьерской службой
2 - Почтой России
3 - Транспортной
компанией
4 - Самовывоз
5 - Постаматы Пикпоинт
transport - название транспортной компании, курьерской службы или ID постамата
comments - комментарий
следующие параметры являются необязательными и относятся к данным отправителя и получателя
наложенного платежа. если какой-либо из параметров не указан, то его значение берется из данных
Вашего профиля в личном кабинете
p_name - имя
p_surname - фамилия
p_fathername - отчество
p_phone - телефон
p_zip - почтовый индекс
p_region - регион (область, край, республика)
p_city - город
p_street - улица
p_house - дом
p_building - строение
p_corps - корпус
p_flat - квартира
passport - паспортные данные
код_товара - это код_1С взятый из остатков в формате CSV либо поле id из остатков в формате XML
Внимание! Параметры запроса необходимо предоставлять в URLencoded формате Внимание!Пожалуйста,
передавайте корректно данные (получателя отправления, получателя наложенного платежа и проч.).
Наши операторы НЕ перезванивают ни Вам ни по указанным Вами контактным данным (получателя
отправления или получателя наложенного платежа) с целью проверки правильности указанных Вами
данных, отправка заказа происходит по данным из Вашего заказа как есть!
Ответ:
Если заказ успешно создан, то возвращается строка okNNNN, где NNNN - код заказа
если возвращается другая строка, то заказ не добавлен, причина ошибки согласно следующей
таблице:
коды ошибок
1. клиент с таким кодом не найден
2. ошибка в списке товаров
3. список товаров пуст
4. ошибка в описании товара в списке товаров
5. указан код несуществующего товара
6. остаток товара на складе меньше заказываемого количества
7. недостаточный баланс у клиента
8. указан сайт, не зарегистрированный в системе
9. указанный сайт был удален из базы
10. указанный сайт деактивирован
11. указанный сайт не имеет статус «экспресс»
Примеры:
заказ на Иванова Ивана Ивановича проживающего по адресу: Московская область, г. Москва, ул.
Красная, д. 1, строение А, кв. 1
http://www.site.com/api/order?partner_id=3731& name=%C8%E2%E0%ED& surname=%C8%E2%E0%ED%EE%E2&
fathername=%C8%E2%E0%ED%EE%E2%E8%F7& phone=%2B79871234560& zip=100000&
region=%CC%EE%F1%EA%EE%E2%F1%EA%E0%FF+%EE%E1%EB%E0%F1%F2%FC& city=%CC%EE%F1%EA%E2%E0&
street=%CA%F0%E0%F1%ED%E0%FF&
house=1&building=A&corps=&flat=1&&items[0][0]=00000011830&items[0][1]=1& sum=2000& delivery=1&
transport=KKK& comments=
заказ на Иванова Ивана Ивановича адрес: Московская область, г. Москва, ул. Красная, д. 1,
строение А, кв. 1. заказ отправляется от Петрова Петра Петровича, адрес: Ленинградская область,
г. Санкт-Петербург, ул. Зеленая, д. 2, кв. 3
http://www.site.com/api/order?partner_id=3731& name=%C8%E2%E0%ED& surname=%C8%E2%E0%ED%EE%E2&
fathername=%C8%E2%E0%ED%EE%E2%E8%F7& phone=%2B79871234560& zip=100000&
region=%CC%EE%F1%EA%EE%E2%F1%EA%E0%FF+%EE%E1%EB%E0%F1%F2%FC& city=%CC%EE%F1%EA%E2%E0&
street=%CA%F0%E0%F1%ED%E0%FF&
house=1&building=A&corps=&flat=1&items[0][0]=00000011830&items[0][1]=1& sum=2000& delivery=1&
transport=KKK& comments=& p_name=%CF%E5%F2%F0& p_surname=%CF%E5%F2%F0%EE%E2&
p_fathername=%CF%E5%F2%F0%EE%E2%E8%F7& p_phone=%2B79991111111& p_zip=100000&
p_region=%CB%E5%ED%E8%ED%E3%F0%E0%E4%F1%EA%E0%FF+%EE%E1%EB%E0%F1%F2%FC& p_city=%D1%E0%ED%EA%F2%CF%E5%F2%E5%F0%E1%F3%F0%E3& p_street=%C7%E5%EB%E5%ED%E0%FF& p_house=2&p_flat=3
Проверка статуса заказа
URL запроса HTTP GET:
http://www.site.com/api/check_status
Параметры запроса:
partner_id - код клиента = 3731
id - код заказа
md5 - md5 от строки получаемой слиянием строк: <кода партнера> <пароль партнера> <код заказа>
Ответ:
-2 - ошибка
-1 - новый заказ
0 - заказ еще не обработан
1 - заказ в обработке
2 - отработан
3 - доставлено
4 - недозвон
5 - отказ
6 - в наличии
7 - подтвержден
8 - отправлен