API (функции постепенно дополняются)
Формат и авторизация
Подробнее о заданиях – на странице документации
метод: POST
content-type: application/json
авторизация: по ключу в теле запроса – {“apikey”:”YOUR-API-KEY”}
Не сообщайте ключ API третьим лицам!
Получение баланса
метод: POST
URL: https://parser.market/wp-json/client-api/v1/get-balanse
Содержимое запроса
{"apikey":"YOUR-API-KEY"}
API-key Вы можете создать или обновить на этой странице
Ответ
[{
"result": "success"
}, {
"error_code": ""
}, {
"your_login": "test_subscriber"
}, {
"your_email": "test_subscriber@mail.ru"
}, {
"checks_free": 800
}, {
"checks_paid": 5000
}, {
"checks_pending": 200
}, {
"checks_total": 5600
}]
Бонусные, оплаченные проверки, проверки в незавершенных заданиях, доступные проверки.
Отправка заданий через API
метод: POST
URL: https://parser.market/wp-json/client-api/v1/send-order
примечание: поле name (название товара) не должно быть пустым, даже если есть корректная ссылка или id карточки товара
Содержимое запроса
{
"apikey": "YOUR-API-KEY",
"regionid": "Санкт-Петербург",
"market": "wbs",
"userlabel": "WBS_SPB_TEST",
"products": [
{
"category": "",
"code": 2023.333333,
"productid": "",
"brand": "",
"name": "1",
"linkset": [
"https://www.wildberries.ru/catalog/0/search.aspx?search=%D0%BB%D0%B5%D1%82%D0%BD%D0%B8%D0%B5%20%D1%88%D0%B8%D0%BD%D1%8B"
],
"marketid": "",
"price": 2023.333333,
"donotsearch": "",
"textsearch": ""
}
]
}
Для краткости массив товарных сокращен до одной.
Подробнее о формате JSON ниже
Ответ
[{
"result": "success"
}, {
"user_id": "3"
}, {
"user_login": "test_subscriber"
}, {
"user_email": "test_subscriber@mail.ru"
}, {
"checks_total": 6524742
}, {
"market": "wbs"
}, {
"userlabel": "WBS_SPB_TEST"
}, {
"region_code": "\u0421\u0430\u043d\u043a\u0442-\u041f\u0435\u0442\u0435\u0440\u0431\u0443\u0440\u0433"
}, {
"bytes": 444
}]
Разбор JSON происходит на следующем шаге, поэтому “success” означает только то, что задание получено API.
По этой же причине API не может сразу выдать id задания, для идентификации заданий используйте userlabel.
Userlabel – ваша собственная метка задания(до 20 символов), если она не указана – она будет сгенерирована как случайная последовательность.
Символы “\”, “/”,”*” заменяются на “-“.
В случае неудачной обработки задания на электронную почту придет соответствующее уведомление.
“checks_total” – бонусные + оплаченные проверки – проверки в незавершенных заданиях
Прогресс выполнения заданий и ссылки на результаты
метод: POST
URL: https://parser.market/wp-json/client-api/v1/get-last50
Содержимое запроса – статус последних заданий
{"apikey":"YOUR-API-KEY",
"limit":3}
Выводится до 50 последних заданий, количество задается параметром limit
Ответ
[{
"result": "success"
}, {
"userid": "3"
}, {
"userlogin": "test_subscriber"
}, {
"data": [
[{
"order-id": 122797
}, {
"received": "2024-04-13 12:57:16"
}, {
"market": "wbs"
}, {
"region-code": "\u0421\u0430\u043d\u043a\u0442-\u041f\u0435\u0442\u0435\u0440\u0431\u0443\u0440\u0433"
}, {
"userlabel": "WBS-SPB-TEST"
}, {
"items-in-price": 1
}, {
"items-loaded": 1
}, {
"status": "completed"
}, {
"report_csv": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125725_region_sankt-peterburg_WBS-SPB-TEST_test_subscriber.csv"
}, {
"report_xlsx": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125725_region_sankt-peterburg_WBS-SPB-TEST_test_subscriber.xlsx"
}, {
"report_xml": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125725_region_sankt-peterburg_WBS-SPB-TEST_test_subscriber.xlsm"
}, {
"report_json": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125725_region_sankt-peterburg_WBS-SPB-TEST_test_subscriber.json"
}],
[{
"order-id": 122796
}, {
"received": "2024-04-13 12:56:07"
}, {
"market": "wbs"
}, {
"region-code": "\u0421\u0430\u043d\u043a\u0442-\u041f\u0435\u0442\u0435\u0440\u0431\u0443\u0440\u0433"
}, {
"userlabel": "aa75db48b7"
}, {
"items-in-price": 1
}, {
"items-loaded": 1
}, {
"status": "completed"
}, {
"report_csv": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125615_region_sankt-peterburg_aa75db48b7_test_subscriber.csv"
}, {
"report_xlsx": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125615_region_sankt-peterburg_aa75db48b7_test_subscriber.xlsx"
}, {
"report_xml": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125615_region_sankt-peterburg_aa75db48b7_test_subscriber.xlsm"
}, {
"report_json": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125615_region_sankt-peterburg_aa75db48b7_test_subscriber.json"
}],
[{
"order-id": 122795
}, {
"received": "2024-04-13 12:50:57"
}, {
"market": "wbs"
}, {
"region-code": "\u0421\u0430\u043d\u043a\u0442-\u041f\u0435\u0442\u0435\u0440\u0431\u0443\u0440\u0433"
}, {
"userlabel": "3121e42195"
}, {
"items-in-price": 1
}, {
"items-loaded": 1
}, {
"status": "completed"
}, {
"report_csv": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125104_region_sankt-peterburg_3121e42195_test_subscriber.csv"
}, {
"report_xlsx": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125104_region_sankt-peterburg_3121e42195_test_subscriber.xlsx"
}, {
"report_xml": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125104_region_sankt-peterburg_3121e42195_test_subscriber.xlsm"
}, {
"report_json": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125104_region_sankt-peterburg_3121e42195_test_subscriber.json"
}]
]
}]
Содержимое запроса – статус заданий по userlabel
{
"apikey": "YOUR-API-KEY",
"userlabels":["WBS-SPB-TEST", "cb40", "aa75db48b7"],
"limit":5
}
Ответ
[{
"result": "success"
}, {
"userid": "3"
}, {
"userlogin": "test_subscriber"
}, {
"data": [
[{
"order-id": 122797
}, {
"received": "2024-04-13 12:57:16"
}, {
"market": "wbs"
}, {
"region-code": "\u0421\u0430\u043d\u043a\u0442-\u041f\u0435\u0442\u0435\u0440\u0431\u0443\u0440\u0433"
}, {
"userlabel": "WBS-SPB-TEST"
}, {
"items-in-price": 1
}, {
"items-loaded": 1
}, {
"status": "completed"
}, {
"report_csv": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125725_region_sankt-peterburg_WBS-SPB-TEST_test_subscriber.csv"
}, {
"report_xlsx": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125725_region_sankt-peterburg_WBS-SPB-TEST_test_subscriber.xlsx"
}, {
"report_xml": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125725_region_sankt-peterburg_WBS-SPB-TEST_test_subscriber.xlsm"
}, {
"report_json": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125725_region_sankt-peterburg_WBS-SPB-TEST_test_subscriber.json"
}],
[{
"order-id": 122796
}, {
"received": "2024-04-13 12:56:07"
}, {
"market": "wbs"
}, {
"region-code": "\u0421\u0430\u043d\u043a\u0442-\u041f\u0435\u0442\u0435\u0440\u0431\u0443\u0440\u0433"
}, {
"userlabel": "aa75db48b7"
}, {
"items-in-price": 1
}, {
"items-loaded": 1
}, {
"status": "completed"
}, {
"report_csv": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125615_region_sankt-peterburg_aa75db48b7_test_subscriber.csv"
}, {
"report_xlsx": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125615_region_sankt-peterburg_aa75db48b7_test_subscriber.xlsx"
}, {
"report_xml": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125615_region_sankt-peterburg_aa75db48b7_test_subscriber.xlsm"
}, {
"report_json": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125615_region_sankt-peterburg_aa75db48b7_test_subscriber.json"
}],
[{
"order-id": 122772
}, {
"received": "2024-04-13 11:44:47"
}, {
"market": "wbs"
}, {
"region-code": "\u0421\u0430\u043d\u043a\u0442-\u041f\u0435\u0442\u0435\u0440\u0431\u0443\u0440\u0433"
}, {
"userlabel": "WBS-SPB-TEST"
}, {
"items-in-price": 1
}, {
"items-loaded": 1
}, {
"status": "completed"
}, {
"report_csv": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-114458_region_sankt-peterburg_WBS-SPB-TEST_test_subscriber.csv"
}, {
"report_xlsx": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-114458_region_sankt-peterburg_WBS-SPB-TEST_test_subscriber.xlsx"
}, {
"report_xml": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-114458_region_sankt-peterburg_WBS-SPB-TEST_test_subscriber.xlsm"
}, {
"report_json": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-114458_region_sankt-peterburg_WBS-SPB-TEST_test_subscriber.json"
}],
[{
"order-id": 122429
}, {
"received": "2024-04-12 08:55:04"
}, {
"market": "ozon"
}, {
"region-code": "\u041c\u043e\u0441\u043a\u0432\u0430"
}, {
"userlabel": "cb40"
}, {
"items-in-price": 29
}, {
"items-loaded": 29
}, {
"status": "waiting"
}, {
"report_xml": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-114458_region_sankt-peterburg_WBS-SPB-TEST_test_subscriber.xlsm"
}]
]
}]
Содержимое запроса – статус заданий по orderid
{
"apikey": "8yvFFiXC+tVAWTxR2ARQPmrv3oQ=",
"orderidlist":[122796, 122624, 122024],
"limit":5
}
Ответ
[{
"result": "success"
}, {
"userid": "3"
}, {
"userlogin": "test_subscriber"
}, {
"data": [
[{
"order-id": 122796
}, {
"received": "2024-04-13 12:56:07"
}, {
"market": "wbs"
}, {
"region-code": "\u0421\u0430\u043d\u043a\u0442-\u041f\u0435\u0442\u0435\u0440\u0431\u0443\u0440\u0433"
}, {
"userlabel": "aa75db48b7"
}, {
"items-in-price": 1
}, {
"items-loaded": 1
}, {
"status": "completed"
}, {
"report_csv": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125615_region_sankt-peterburg_aa75db48b7_test_subscriber.csv"
}, {
"report_xlsx": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125615_region_sankt-peterburg_aa75db48b7_test_subscriber.xlsx"
}, {
"report_xml": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125615_region_sankt-peterburg_aa75db48b7_test_subscriber.xlsm"
}, {
"report_json": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240413-125615_region_sankt-peterburg_aa75db48b7_test_subscriber.json"
}],
[{
"order-id": 122624
}, {
"received": "2024-04-12 17:59:52"
}, {
"market": "ozons"
}, {
"region-code": "\u041c\u043e\u0441\u043a\u0432\u0430"
}, {
"userlabel": "9d05"
}, {
"items-in-price": 1
}, {
"items-loaded": 1
}, {
"status": "completed"
}, {
"report_xml": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240412-175959_region_moskva_9d05_test_subscriber.xlsm"
}, {
"report_json": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240412-175959_region_moskva_9d05_test_subscriber.json"
}],
[{
"order-id": 122024
}, {
"received": "2024-04-10 13:33:28"
}, {
"market": "ozon"
}, {
"region-code": "\u041c\u043e\u0441\u043a\u0432\u0430"
}, {
"userlabel": "224a"
}, {
"items-in-price": 10
}, {
"items-loaded": 10
}, {
"status": "completed"
}, {
"report_xml": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240410-133818_region_moskva_224a_test_subscriber.xlsm"
}, {
"report_json": "https:\/\/files.parser.market\/_filestorage\/JkaBm\/csid000003\/20240410-133818_region_moskva_224a_test_subscriber.json"
}]
]
}]
Задание в формате JSON
Поля файла-задания в формате JSON аналогичны образцу задания XLS .
Все поля и их регистр должны в точности сохраняться, для отсутствующих значений указывайте “”, если строка, 0.0, если число, [], если массив.
Чтобы отправить задание в формате JSON, требуется API-ключ (API пока в разработке), сгенерировать/обновить его можно на странице “Мои задания”.
Также требуется указание кода региона, если он не совпадет с кодом, указанным при отправке из формы – будет принят код из формы.
Как и в образце задания XLS, единственным обязательным для заполнения полем в массиве товарных позиций является поле name.
Задание в JSON одинаково как для отправки через форму сайта (файл *.json), так и для отправки через API.