Маркировка
Описание функций облака Маркировки. Хост: https://barcode.upd2xml.ru
/podbor_status.php Проверка статуса подбора в документ.
Метод POST. Используется для определения находится ли документ (контейнер) в подборе, завершен подобор или нет, возвращает количество подобранных кодов маркировки.
Формат запроса:
curl -X POST "url_метода"
-H "Content-type: application/json; charset=utf-8"
-d {"key":"api_key", "id":id_документа_контейнера}
или
curl -X POST "url_метода"
-H "Content-type: application/json; charset=utf-8"
-d {"key":"api_key", "guid":"guid_документа_контейнера"}
при запросе используйте параметр id(integer) или guid(string) документа/контейнера.
Ответ:
-H "Content-type: application/json; charset=utf-8"
-d {"rez":статус_подбора, "kolvo":количество_кодов, "id":id_документа_контейнера}
где
rez - integer, -1 - ошибка ключа, 0 - подбор в документ/контейнер не производился, 1 - подбор начат, 2 - в документ подобраны коды, 3 - подбор завершен;
kolvo - integer, количество подобранных кодов.
/podbor.php Начать подбор в документ. Чтение подобранных кодов.
Метод POST. Используется для начала подбора в документ/контейнер и для чтения подобранных кодов.
Формат запроса для добавления документа/контейнера в подбор:
curl -X POST "url_метода"
-H "Content-type: application/json; charset=utf-8"
-d {"key":"api_key", "guid":"guid_документа_контейнера", "name":"наименование_документа_контейнера", "dt":"yyyy-MM-dd HH:mm:ss"}
Ответ:
-H "Content-type: text/html; charset=utf-8"
id_документа_контейнера(integer)\r\n
статус_подбора(integer)\r\n
где статус_подбора - -1 - ошибка ключа, 0 - подбор в документ/контейнер не производился, 1 - подбор начат, 2 - в документ подобраны коды, 3 - подбор завершен.
Формат запроса для чтения подобранных в документ кодов:
curl -X POST "url_метода"
-H "Content-type: application/json; charset=utf-8"
-d {"key":"api_key", "id":id_документа_контейнера, "krypto":0, "cont":0}
при запросе используйте параметр id(integer) или guid(string) документа/контейнера.
Параметр krypto(integer) - необязательный. Если 0 коды в ответе будут возвращены без крипточасти, 1 - с крипточастями.
Параметр cont(integer) - необязательный. Если 0 - возвращаются коды единиц (контейнеры которые были подобраны в документ разагрегируются), 1 - коды возвращаются в том виде, в котором были отправлены при подборе (контейнеры не разагрегируются до единиц).
Ответ:
-H "Content-type: text/html; charset=utf-8"
id_документа_контейнера(integer)\r\n
статус_подбора(integer)\r\n
код1(string)\r\n
код2(string)\r\n
...
кодN(string)\r\n
где статус_подбора - -1 - ошибка ключа, 0 - подбор в документ/контейнер не производился, 1 - подбор начат, 2 - в документ подобраны коды, 3 - подбор завершен
/podbor_done.php Завершить подбор в документ.
Метод POST. Используется для завершения подбора в документ (контейнер).
Формат запроса:
curl -X POST "url_метода"
-H "Content-type: application/json; charset=utf-8"
-d {"key":"api_key", "id":id_документа_контейнера}
или
curl -X POST "url_метода"
-H "Content-type: application/json; charset=utf-8"
-d {"key":"api_key", "guid":"guid_документа_контейнера"}
при запросе используйте параметр id(integer) или guid(string) документа/контейнера.
Ответ:
-H "Content-type: application/json; charset=utf-8"
-d {"rez":статус_подбора}
где
rez - integer, -1 - ошибка ключа, 0 - документ не найден, 1 - завершение подбора выполнено.
/podbor_clear.php Удалить документ и коды из подбора.
Метод POST. Используется для удаления всех данных о подборе в документ (контейнер).
Формат запроса:
curl -X POST "url_метода"
-H "Content-type: application/json; charset=utf-8"
-d {"key":"api_key", "id":id_документа_контейнера}
или
curl -X POST "url_метода"
-H "Content-type: application/json; charset=utf-8"
-d {"key":"api_key", "guid":"guid_документа_контейнера"}
при запросе используйте параметр id(integer) или guid(string) документа/контейнера.
Ответ:
-H "Content-type: application/json; charset=utf-8"
-d {"rez":статус_удаления}
где
rez - integer, -1 - ошибка ключа, 0 - документ не найден, 1 - удаление выполнено.
/podbor_true_api.php Данные для проверки кодов маркировки на сканере.
Метод POST. Используется для записи в облаке данных, используемых сканером для провки кодов маркировки.
Формат запроса:
curl -X POST "url_метода"
-H "Content-type: application/json; charset=utf-8"
-d {"key":"api_key", "doc_id":id_документа_контейнера, "true_api_km_status":статусы_КМ, "true_api_inn":ИНН_владельца, "true_api_token":токей_единой_авторизации}
key(string) - ключ облака Маркировка;
doc_id(integer) - id документа/контейнера;
true_api_km_status(string) - статус кодов, INTRODUCED - в обороте, APPLIED - нанесен, EMITTED - эмитирован;
true_api_inn(string) - ИНН владельца;
true_api_token(string) - токен единой авторизации (token), см. функцию TRUE API ЧЗ auth/key.
Ответ:
-H "Content-type: application/json; charset=utf-8"
-d {"firm_id":id_фирмы, "doc_id":id_документа_контейнера}
/podbor_copy.php Скопировать КМ с документа-источника в документ-приемник.
Метод POST. Для копирования подобранных кодов из одного документа в другой.
Формат запроса:
curl -X POST "url_метода"
-H "Content-type: application/json; charset=utf-8"
-d {"key":"api_key", "guid1":"guid_документа_источника", "guid2":"guid_документа_приемника"}
key(string) - ключ облака Маркировка;
guid1(string) - GUID документа;
guid2(string) - GUID документа.
Ответ:
-H "Content-type: application/json; charset=utf-8"
-d {"rez":id_результата, "err_msg":"сообщение об ошибке"}
где
rez - integer, -1 - ошибка ключа, 0 - документ не найден или не выполнен подбор в документ-источник, 1 - ok.
/cont.php Получить содержимое контейнера/коробки.
Метод POST. Возвращает коды маркировки, вложенные в контейнер.
Формат запроса:
curl -X POST "url_метода"
-H "Content-type: application/json; charset=utf-8"
-d {"key":"api_key", "kod":"штрихкод_коробки_контейнера"}
Ответ:
-H "Content-type: text/html; charset=utf-8"
результат_поиска\r\n
код1\r\n
код2\r\n
...
кодN\r\n
где
результат_поиска - integer, -1 - ошибка запроса, неправильный api-ключ, 0 - контейнер/коробка отсутствует, 1 - контейнер/коробка найден;
код1, код2, ... кодN - штрихкоды содержимого коробки/контейнера.
/podbor_get_docs.php Получить список документов для подбора.
Метод GET. Используется для получения списка документов и их id, по которым не завершен подбор.
Формат запроса:
curl -X GET "url_метода"?key=api_key
-H "Content-type: application/json; charset=utf-8"
Ответ:
-H "Content-type: application/json; charset=utf-8"
-d {"ids":[id1, id2, ... idN], "names":["name1", "name2", ... "nameN"]}
где
id1, id2, ... idN - array of integer, идентификаторы документов/контейнеров;
name1, name2, ... nameN - array of string , наименования документов/контейнеров.
/in3.php Добавить коды в документ.
Метод POST. Используется для непосредственного добавления кодов в облако, в документы и контейнеры.
Формат запроса:
curl -X POST "url_метода"?key=api_key&dt=данные
-H "Content-type: application/json; charset=utf-8"
-d key=api_key & dt=данные
Формат данных dt для подбора кодов в документ:
#PODBOR~\n
id_документа1\n
код1\n
код2\n
...
кодN\n
#PODBOR~\n
id_документа2\n
код1\n
код2\n
...
кодN\n
Формат данных для добавления кодов в облако:
#REGULAR_SCAN~\n
код1\n
код2\n
...
кодN\n
Формат данных для сохранения кодов, вложенных в контейнер/коробку:
#CONTAINER~\n
код_контейнера1\n
код1\n
код2\n
...
кодN\n
#CONTAINER~\n
код_контейнера2\n
код1\n
код2\n
...
кодN\n
Ответ:
-H "Content-type: text/html; charset=utf-8"
-d результат
где
результат - integer, 0 - добавлено, 1 - ошибка.