Описание API EdiAgent
Доступные методы API (Табл. 1).
| # | Описание | URL | Метод | Заголовки | Тело запроса |
|---|---|---|---|---|---|
| 1 | Проверка соединения | /document/authorize/ | GET | gln, uname, passwd | нет |
| 2 | Получить список входящих документов | /document/get_headers/ | POST | gln, uname, passwd | нет |
| 3 | Получить документ | /document/get_doc/ | POST | gln, uname, passwd, uid | нет |
| 4 | Принять документ | /document/accept_doc/ | POST | gln, uname, passwd, uid, doc_no, datetime, accept_doc, reason, | нет |
| 5 | Комментировать документ | /document/comment_doc/ | POST | gln, uname, passwd, uid, comment | нет |
| 6 | Отправить классификатор | /document/ | POST | gln, uname, passwd | XML файл |
| 7 | Получить классификаторы | /document/get_classificator/ | POST | gln, uname, passwd, tname | нет |
| 8 | Получить прикрепленное фото | /document/get_doc_photo/ | POST | gln, uname, passwd, uid, photo_id | нет |
| 9 | Заргузить фото для товара | /document/upload_product_photo/ | POST | gln, uname, passwd, файл (jpg|jpeg|png|gif) | нет |
Табл. 1. Список доступных методов API
Заголовки (Табл. 2).
| # | Описание | Имя заголовка | Тип | Доступные значения | Пример |
|---|---|---|---|---|---|
| 1 | GLN номер организации | gln | Строка(13) | 2000000000720 | |
| 2 | Логин или имя учетной записи Администратора | uname | Строка(50) | Admin-1 | |
| 3 | md5 хэш пароля от учетной записи Администратора | passwd | Строка(32) | md5(12345pass) | 6211388071174dc9808f776a2fc4e771 |
| 4 | Уникальный номер документа | uid | Строка(16) | 0000000d55ad0e6b | |
| 5 | Номер документа в учетной системе клиента | doc_no | Строка(255) | Заказ #001624 | |
| 6 | Подтверждение приема документа | accept_doc | Число | 1 или 0 | 1 |
| 7 | Причина отклонения (if accept_doc = 0) | reason | Строка(255) | Document incorrect | |
| 8 | Имя таблицы классификатора | tname | Строка(255) | agents, trade_points, prices, etc. | trade_points |
| 9 | Код фото на сервере | photo_id | Строка(255) | 95 | |
| 10 | Дата операции | datetime | Строка(255) | 2015-08-09 18:31:42 |
Табл. 2. Список заголовков
Проверка соединения
Зеленым цветом выделены обязательные параметры методов
Заголовки запроса (Табл. 3).
| # | Параметр | Заголовок | Описание/Пример |
|---|---|---|---|
| 1 | GLN | Строка(13) | Уникальный код организации, выдается при регистрации |
| 2 | uname | Строка(20) | Имя пользователя |
| 3 | passwd | Строка(20) | MD5 хэш пароля пользователя |
Табл. 3. Параметры метода «Проверка соединения»
Тело запроса
нет
GET https://agent.ediweb.ru/document/authorize/200
Успешное соединение
GET https://agent.ediweb.ru/document/authorize/401
Ошибка авторизации
Получение списка документов
Заголовки запроса (Табл. 4).
| # | Параметр | Заголовок | Описание/Пример |
|---|---|---|---|
| 1 | GLN | Строка(13) | Уникальный код организации, выдается при регистрации |
| 2 | uname | Строка(20) | Имя пользователя |
| 3 | passwd | Строка(20) | MD5 хэш пароля пользователя |
| 4 | dates | Строка(17) | Период за который нужно выбрать входящие документы, например : 21022015-28022015 |
Табл. 4. Параметры метода «Получение списка документов»
Тело запроса
нет
POST https://agent.ediweb.ru/document/get_headers/200
<table count="2" name="doc_headers_base">
<row agent_name="Сергей Тестовый" creator="test_agent01" date_create="2016-06-05T10:34:17" deliver_date="2016-06-06T12:00:00" doc_sum="250.0" doc_type_id="1" document_date="2016-06-05T10:34:17" received_date="2016-06-05T10:36:34" trade_point_name="Алхимов А.А." uid="000000015753d5f9" />
<row agent_name="Сергей Тестовый" creator="test_agent01" date_create="2016-06-23T19:13:10" deliver_date="2016-06-25T07:00:00" doc_sum="0.0" doc_type_id="1" document_date="2016-06-23T19:15:10" received_date="2016-06-23T19:15:29" trade_point_name="Алхимов А.А." uid="00000001576c0a96" />
</table>
Получение документа
Заголовки запроса (Табл. 5).
| # | Параметр | Заголовок | Описание/Пример |
|---|---|---|---|
| 1 | GLN | Строка(13) | Уникальный код организации, выдается при регистрации |
| 2 | uname | Строка(20) | Имя пользователя |
| 3 | passwd | Строка(20) | Пароль пользователя |
| 4 | uid | Строка(16) | Уникальный номер документа |
Табл. 5. Параметры метода «Получение документа»
Тело запроса
нет
POST https://agent.ediweb.ru/document/get_doc/200
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<root>
<doc>
<header>
<table name="doc_order">
<row agent_name="Сергей Тестовый" client_id="1" client_name="1" creator="test_agent01" date_create="2016-06-05T10:34:17" discount_id="0" doc_sum="250.00" doc_type_id="1" document_date="2016-06-05T10:34:17" is_deleted="0" local_status_id="2" network_status_id="2" organization_actual_address="Россия, Москва, Красная площадь, д.5" organization_id="2000000000720" organization_juridical_address="Россия, Москва, Красная площадь, д.7" organization_name="Test Android Agent" organization_rceo="40003461000" store_id="1" trade_point_actual_address="119019, Москва г, Москва, Арбатская пл, дом № 1, корпус 2" trade_point_id="109675" trade_point_name="Алхимов А.А." type_of_price_id="000000002" uid="000000015753d5f9"/>
</table>
</header>
<t_parts count="5">
<table count="1" name="doc_order_products">
<row doc_header_id="2649" good_name="Женские ботфорты коричневые" id="1677" is_deleted="0" m_unit_id="715" price="250.00" product_id="00000000018" quantity="1" sum="250.00"/>
</table>
<table count="2" name="doc_order_requisites">
<row doc_header_id="2649" id="2888" is_deleted="0" req_value="1465203600" requisite_data_type="date" requisite_id="DeliverDate" requisite_name="Дата доставки"/>
<row doc_header_id="2649" id="2889" is_deleted="0" req_value="0" requisite_data_type="boolean" requisite_id="PaymentTerms" requisite_name="Акция"/>
</table>
<table count="0" name="doc_order_goods_req"/>
<table count="1" name="doc_history">
<row comment="Документ принят сервером" doc_header_id="2649" id="3278" is_deleted="0" operation="RECEIVED" operation_date="2016-06-05T10:36:34"/>
</table>
<table count="0" name="photos"/>
</t_parts>
</doc>
</root>
Подтверждение приема документа / Отклонение документа
Заголовки запроса (Табл. 6).
| # | Параметр | Заголовок | Описание/Пример |
|---|---|---|---|
| 1 | GLN | Строка(13) | Уникальный код организации, выдается при регистрации |
| 2 | uname | Строка(20) | Имя пользователя |
| 3 | passwd | Строка(20) | Пароль пользователя |
| 4 | uid | Строка(16) | Уникальный номер документа |
| 7 | accept_doc | Строка(1) | Пометка подтвержнения или отклонения документа (передается 1 или 0) |
| 6 | datetime | Строка(255) | Дата приема документа в учетной системе (если accept_doc=1) |
| 5 | doc_no | Строка(255) | Номер документа в учетной системе (если accept_doc=1) |
| 8 | reason | Строка(255) | Причина отклонения (если accept_doc=0) |
Табл. 6. Параметры метода «Подтверждение приема документа / Отклонение документа»
Тело запроса
нет
POST https://agent.ediweb.ru/document/accept_doc/200
Документ успешно подтвержден.
POST https://agent.ediweb.ru/document/accept_doc/400
Заполнены не все заголовки. Отсутствуют: datetime, accept_doc.
Комментирование документа
Заголовки запроса (Табл. 7).
| # | Параметр | Заголовок | Описание/Пример |
|---|---|---|---|
| 1 | GLN | Строка(13) | Уникальный код организации, выдается при регистрации |
| 2 | uname | Строка(20) | Имя пользователя |
| 3 | passwd | Строка(20) | Пароль пользователя |
| 4 | uid | Строка(16) | Уникальный номер документа |
| 5 | comment | Строка(255) | Текст комментария |
Табл. 7. Параметры метода «Комментирование документа»
Тело запроса
нет
POST https://agent.ediweb.ru/document/comment_doc/200
Комментарий к документу добавлен успешно.
POST https://agent.ediweb.ru/document/comment_doc/200
Ошибка добавления комментария к документу.
Отправка классификаторов
Заголовки запроса (Табл. 8).
| # | Параметр | Заголовок | Описание/Пример |
|---|---|---|---|
| 1 | GLN | Строка(13) | Уникальный код организации, выдается при регистрации |
| 2 | uname | Строка(20) | Имя пользователя |
| 3 | passwd | Строка(20) | Пароль пользователя |
| 4 | dates | Строка(17) | Период за который нужно выбрать входящие документы, например : 21022015-28022015 |
Табл. 8. Параметры метода «Отправка классификаторов»
Тело запроса
<table name="trade_points" clear="1">
<row name="Белявский-частное лицо" actual_address="190000, Санкт-Петербург г, Москва, Добровольцев ул, дом № 1" ext_uid="Ф00000002"/>
<row name="ИнноТрейд" actual_address="305007, Курская обл, Курск г, Автодромный 1-й пер, дом № 000" ext_uid="Ю00000017"/>
<row name="Алхимов А.А." actual_address="119019, Москва г, Москва, Арбатская пл, дом № 1, корпус 2" ext_uid="109675"/>
<row name="Монолит" actual_address="197706, Санкт-Петербург г, Сестрорецк г, Андреева ул, дом № 78" ext_uid="Ю00000020"/>
<row name="Бытовая техника" actual_address="119048, Москва г, 10-летия Октября ул, дом № 78" ext_uid="Ю00000002"/>
<row name="Мосимущество" actual_address="Москва, Каретный ряд, дом № 2/1" ext_uid="Ю00000050"/>
<row name="Павлов" actual_address="Москва г" ext_uid="Ю00000059"/>
<row name="Симонов" actual_address="Москва г" ext_uid="Ю00000060"/>
<row name="Гришичкин" actual_address="Москва г, Севастопольский проезд 34" ext_uid="Ю00000061"/>
</table>
POST https://agent.ediweb.ru/document/200
Классификатор trade_points успешно обновлён (9 записей)
POST https://agent.ediweb.ru/document/200
Ошибка обновления/добавления классификатора.
Получение классификаторов
Заголовки запроса (Табл. 9).
| # | Параметр | Заголовок | Описание/Пример |
|---|---|---|---|
| 1 | GLN | Строка(13) | Уникальный код организации, выдается при регистрации |
| 2 | uname | Строка(20) | Имя пользователя |
| 3 | passwd | Строка(20) | Пароль пользователя |
| 4 | dates | Строка(17) | Период за который нужно выбрать входящие документы, например : 21022015-28022015 |
| 5 | tname | Строка(50) | Имя классификатора, который требуется получить |
Табл. 9. Параметры метода «Получение классификаторов»
Тело запроса
нет
POST https://agent.ediweb.ru/document/200
<?xml version="1.0" encoding="UTF-8" standalone="no">
<table name="trade_points" clear="1">
<row name="Белявский-частное лицо" actual_address="190000, Санкт-Петербург г, Москва, Добровольцев ул, дом № 1" ext_uid="Ф00000002"/>
<row name="ИнноТрейд" actual_address="305007, Курская обл, Курск г, Автодромный 1-й пер, дом № 000" ext_uid="Ю00000017"/>
<row name="Алхимов А.А." actual_address="119019, Москва г, Москва, Арбатская пл, дом № 1, корпус 2" ext_uid="109675"/>
<row name="Монолит" actual_address="197706, Санкт-Петербург г, Сестрорецк г, Андреева ул, дом № 78" ext_uid="Ю00000020"/>
<row name="Бытовая техника" actual_address="119048, Москва г, 10-летия Октября ул, дом № 78" ext_uid="Ю00000002"/>
<row name="Мосимущество" actual_address="Москва, Каретный ряд, дом № 2/1" ext_uid="Ю00000050"/>
<row name="Павлов" actual_address="Москва г" ext_uid="Ю00000059"/>
<row name="Симонов" actual_address="Москва г" ext_uid="Ю00000060"/>
<row name="Гришичкин" actual_address="Москва г, Севастопольский проезд 34" ext_uid="Ю00000061"/>
</table>
Получение прикрепленных изображений
Заголовки запроса (Табл. 10).
| # | Заголовок | Тип | Описание/Пример |
|---|---|---|---|
| 1 | GLN | Строка(13) | Уникальный код организации, выдается при регистрации |
| 2 | uname | Строка(20) | Имя пользователя |
| 3 | passwd | Строка(20) | Пароль пользователя |
| 4 | uid | Строка(50) | Уникальный номер документа |
| 5 | photo_id | Строка(50) | Уникальный номер изображения (id) |
Табл. 10. Параметры метода «Получение прикрепленных изображений»
Тело запроса
нет
POST https://agent.ediweb.ru/document/get_doc_photo/200
Массив байт
Загрузка изображений товаров на сервер
Заголовки запроса (Табл. 11).
| # | Заголовок | Тип | Описание/Пример |
|---|---|---|---|
| 1 | GLN | Строка(13) | Уникальный код организации, выдается при регистрации |
| 2 | uname | Строка(20) | Имя пользователя |
| 3 | passwd | Строка(20) | Пароль пользователя |
Табл. 11. Параметры метода «Загрузка изображений товаров на сервер»
Тело запроса
fileUpload, MultipartFile
POST https://agent.ediweb.ru/document/upload_product_photo/200
Успешно загружено фоторгафий - 1
POST https://agent.ediweb.ru/document/upload_product_photo/200
Успешно загружено фоторгафий - 0 000000094.png: не существует