Запрос
HTTP-метод: GET
Тело ответа:
success
- флаг, в зависимости от успешности запроса - содержит true/falsedata
- содержит результат выполнения запроса. При неудачном запросе - возвращает информацию об ошибке
Успешный запрос:
{ "success": true, "data": { "property": "value", "second_property": "second_value" } }
Запрос с ошибкой:
{ "success": false, "data": { "name": "Unauthorized", "message" : "Your request was made with invalid credentials", "code": 0, "status": 401 } }* Параметр
message
может быть не задан
Аутентификация
- Проходит с помощью API ключа
- Имя параметра для ключа -
key
- Получить можно в настройках
- (!) Не передавайте ключ третьим лицам!
Лимиты и блокировки
Разрешено: не более 2 запросов в секунду. При превышении лимита, возвращается ошибка 429 Too Many Requests
.
Если Вам необходимо расширить API лимит, пожалуйста, свяжитесь в Telegram:
@andy_auc.
Если Вы попали под блокировку IP — пожалуйста, свяжитесь с нами для внесения IP в WhiteList.
API Клиенты
-
Мы имеем готовую библиотеку для взаимодействия с API для языка программирования PHP
https://github.com/keystore-api/keystore-client-php
Формат ответа
Доступные форматы: JSON, XML.
Формат определяется в зависимости от содержимого свойства Accept
в заголовке запроса.
Формат для JSON:
Accept: application/json
Формат для XML:
Accept: application/xml
Определить ответ вне зависимости от заголовка можно с помощью GET-параметр _format
.
Пример: _format=json
Пагинация
Пагинация (постраничная навигация) — способ представления большого количества однотипной информации, когда контент разбивается на страницы. Например, используется в выводе списка товаров.
Пример ответа, содержащий пагинацию:
{ "success": true, "data": { "items": [], "_links": { "self": { "href": "https://dark.shopping/api/v1/entity/list?key=2ddbf242b63f193b8e810109b6eb1d47939cdf8f&page=1" }, "first": { "href": "https://dark.shopping/api/v1/entity/list?key=2ddbf242b63f193b8e810109b6eb1d47939cdf8f&page=1" }, "last": { "href": "https://dark.shopping/api/v1/entity/list?key=2ddbf242b63f193b8e810109b6eb1d47939cdf8f&page=8" }, "next": { "href": "https://dark.shopping/api/v1/entity/list?key=2ddbf242b63f193b8e810109b6eb1d47939cdf8f&page=2" } }, "_meta": { "totalCount": 150, "pageCount": 8, "currentPage": 1, "perPage": 20 } }
Чтобы указать число выводимых записей на одной странице - используйте GET-параметр: per-page
.
Пример: per-page=200
.
Обычно лимит: минимально записей - 1, максимально - 1000. Лимит может отличаться в разных методах API.
Список категорий
Основная информация
Метод | category/list | ||||||
Возвращает |
Массив объектов категории
|
||||||
Пример URL | https://dark.shopping/api/v1/category/list?key=7dc8d2ee5cc18c81fe1d7326380fbd1e |
Параметры запроса
Имя параметра | Тип данных | Описание |
---|---|---|
key | string | API ключ |
Пример ответа:
{ "success": true, "data": { "items": [ { "id": 1, "name": "Steam", "icon": "https://dark.shopping/media/no-miniature.png" }, { "id": 2, "name": "Myself", "icon": "https://dark.shopping/media/no-miniature.png" }, { "id": 3, "name": "Origin", "icon": "https://dark.shopping/media/no-miniature.png" }, { "id": 4, "name": "EA", "icon": "https://dark.shopping/media/no-miniature.png" }, { "id": 5, "name": "Steam", "icon": "https://dark.shopping/media/no-miniature.png" }, { "id": 6, "name": "Myself", "icon": "https://dark.shopping/media/no-miniature.png" }, { "id": 7, "name": "Origin", "icon": "https://dark.shopping/media/no-miniature.png" }, { "id": 8, "name": "EA", "icon": "https://dark.shopping/media/no-miniature.png" }, { "id": 9, "name": "Steam", "icon": "https://dark.shopping/media/no-miniature.png" }, { "id": 10, "name": "Myself", "icon": "https://dark.shopping/media/no-miniature.png" }, { "id": 11, "name": "Origin", "icon": "https://dark.shopping/media/no-miniature.png" }, { "id": 12, "name": "EA", "icon": "https://dark.shopping/media/no-miniature.png" } ], "_links": { "self": { "href": "https://dark.shopping/api/v1/category/list?key=3acdfabf09716baedc133cb60488ed207e7ee730&page=1" }, "first": { "href": "https://dark.shopping/api/v1/category/list?key=3acdfabf09716baedc133cb60488ed207e7ee730&page=1" }, "last": { "href": "https://dark.shopping/api/v1/category/list?key=3acdfabf09716baedc133cb60488ed207e7ee730&page=1" } }, "_meta": { "totalCount": 12, "pageCount": 1, "currentPage": 1, "perPage": 20 } } }
Список групп
Основная информация
Метод | group/list | ||||||
Возвращает |
Массив объектов групп
|
||||||
Пример URL | https://dark.shopping/api/v1/group/list?key=7dc8d2ee5cc18c81fe1d7326380fbd1e |
Параметры запроса
Имя параметра | Тип данных | Описание |
---|---|---|
key | string | API ключ |
Поисковые параметры: | ||
ids | array | ID'ы групп |
category_id | integer | Категория группы |
name | string | Имя группы |
Пример ответа:
{ "success": true, "data": { "items": [ { "id": 26, "category_id": 12, "name": "Assumenda" } ], "_links": { "self": { "href": "https://dark.shopping/api/v1/group/list?key=3acdfabf09716baedc133cb60488ed207e7ee730&per-page=1&page=1" }, "first": { "href": "https://dark.shopping/api/v1/group/list?key=3acdfabf09716baedc133cb60488ed207e7ee730&per-page=1&page=1" }, "last": { "href": "https://dark.shopping/api/v1/group/list?key=3acdfabf09716baedc133cb60488ed207e7ee730&per-page=1&page=26" }, "next": { "href": "https://dark.shopping/api/v1/group/list?key=3acdfabf09716baedc133cb60488ed207e7ee730&per-page=1&page=2" } }, "_meta": { "totalCount": 26, "pageCount": 26, "currentPage": 1, "perPage": 1 } } }
Список товаров
Основная информация
Метод | product/list |
Возвращает | Массив объектов товара. Детали по полям ищите в следующем разделе "Просмотр товара" |
Пример URL | https://dark.shopping/api/v1/product/list?key=7dc8d2ee5cc18c81fe1d7326380fbd1e |
Параметры запроса
only_in_stock
со значением true
, чтобы получать только активные товары.
Если Вам нужны товары только от наших эксклюзивных Поставщиков — установите параметр only_exclusive
в true
.
Имя параметра | Тип данных | Описание |
---|---|---|
key | string | API ключ |
Поисковые параметры: | ||
ids | array |
ID'ы товаров. Передаётся массивом. Например: ids[]=14879&ids[]=67989
|
name | string | Имя товара |
description | string | Описание товара |
category_id | integer | Категория товара |
group_id | integer | Группа товара |
only_in_stock | boolean(0/1) | Только товары в наличие |
only_exclusive | boolean(0/1) | Только эксклюзивные товары из Панели Поставщиков |
Пример ответа:
{ "success": true, "data": { "items": [ { "id": 3844, "name": "Iure repudiandae sit et numquam", "miniature": "https://dark.shopping/media/products/42a2650c72ed14bf1b971f14368bde2a.jpg", "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Dictum varius duis at consectetur lorem donec massa sapien faucibus. Metus dictum at tempor commodo. Nisl vel pretium lectus quam id. In hac habitasse platea dictumst. Nec ultrices dui sapien eget mi proin sed libero. Metus vulputate eu scelerisque felis imperdiet proin fermentum leo vel. Lacinia at quis risus sed vulputate odio ut enim blandit. Mi ipsum faucibus vitae aliquet. Eros donec ac odio tempor orci. Nibh nisl condimentum id venenatis a condimentum vitae sapien. Consequat semper viverra nam libero justo laoreet. Pellentesque elit eget gravida cum sociis natoque penatibus et magnis. Justo eget magna fermentum iaculis eu non. Gravida quis blandit turpis cursus. Lobortis elementum nibh tellus molestie nunc non blandit massa enim. Dictum sit amet justo donec enim diam vulputate ut pharetra. Non arcu risus quis varius quam quisque id. Mauris commodo quis imperdiet massa tincidunt nunc.", "manual": "", "price": 123.9, "minimum_order": 2, "quantity": 8816, "purchase_counter": 55625, "view": 0, "group": { "id": 52, "category_id": 28, "name": "Id" }, "category": { "id": 28, "name": "Steam", "icon": "https://dark.shopping/media/no-miniature.png" }, "url": "https://dark.shopping/products/view/iure-repudiandae-sit-et-numquam", "replacement_terms_public": "Lorem proin laoreet aliquet metus, sit amet laoreet diam." }, { "id": 3845, "name": "Voluptas saepe natus", "miniature": "https://dark.shopping/media/products/1dbb638740c36484830f0c72135e153e.jpg", "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Dictum varius duis at consectetur lorem donec massa sapien faucibus. Metus dictum at tempor commodo. Nisl vel pretium lectus quam id. In hac habitasse platea dictumst. Nec ultrices dui sapien eget mi proin sed libero. Metus vulputate eu scelerisque felis imperdiet proin fermentum leo vel. Lacinia at quis risus sed vulputate odio ut enim blandit. Mi ipsum faucibus vitae aliquet. Eros donec ac odio tempor orci. Nibh nisl condimentum id venenatis a condimentum vitae sapien. Consequat semper viverra nam libero justo laoreet. Pellentesque elit eget gravida cum sociis natoque penatibus et magnis. Justo eget magna fermentum iaculis eu non. Gravida quis blandit turpis cursus. Lobortis elementum nibh tellus molestie nunc non blandit massa enim. Dictum sit amet justo donec enim diam vulputate ut pharetra. Non arcu risus quis varius quam quisque id. Mauris commodo quis imperdiet massa tincidunt nunc.", "manual": "", "price": 846.3, "minimum_order": 2, "quantity": 1275, "purchase_counter": 70952, "view": 0, "group": { "id": 52, "category_id": 28, "name": "Id" }, "category": { "id": 28, "name": "Steam", "icon": "https://dark.shopping/media/no-miniature.png" }, "url": "https://dark.shopping/products/view/voluptas-saepe-natus", "replacement_terms_public": "Lorem ipsum adipiscing elit, sed do eiusmod tempor incididunt." }, { "id": 3846, "name": "Itaque ducimus non delectus adipisci", "miniature": "https://dark.shopping/media/products/b6b0795f1a24067fff9b29f430af4677.jpg", "description" : "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Dictum varius duis at consectetur lorem donec massa sapien faucibus. Metus dictum at tempor commodo. Nisl vel pretium lectus quam id. In hac habitasse platea dictumst. Nec ultrices dui sapien eget mi proin sed libero. Metus vulputate eu scelerisque felis imperdiet proin fermentum leo vel. Lacinia at quis risus sed vulputate odio ut enim blandit. Mi ipsum faucibus vitae aliquet. Eros donec ac odio tempor orci. Nibh nisl condimentum id venenatis a condimentum vitae sapien. Consequat semper viverra nam libero justo laoreet. Pellentesque elit eget gravida cum sociis natoque penatibus et magnis. Justo eget magna fermentum iaculis eu non. Gravida quis blandit turpis cursus. Lobortis elementum nibh tellus molestie nunc non blandit massa enim. Dictum sit amet justo donec enim diam vulputate ut pharetra. Non arcu risus quis varius quam quisque id. Mauris commodo quis imperdiet massa tincidunt nunc.", "manual": "1. Nisl vel pretium lectus quam id; 2. In hac habitasse platea dictumst. Nec ultrices dui sapien eget mi proin sed libero. 3. Mi ipsum faucibus vitae aliquet. Eros donec ac odio tempor orci", "price": 362.25, "minimum_order": 1, "quantity": 4601, "purchase_counter": 19942, "view": 0, "group": { "id": 52, "category_id": 28, "name": "Id" }, "category": { "id": 28, "name": "Steam", "icon": "https://dark.shopping/media/no-miniature.png" }, "url": "https://dark.shopping/products/view/itaque-ducimus-non-delectus-adipisci", "replacement_terms_public": "Lorem ipsum adipiscing elit, sed do eiusmod tempor incididunt." } ], "_links": { "self": { "href": "https://dark.shoppingapi/v1/product/list?key=2ddbf242b63f193b8e810109b6eb1d47939cdf8f&page=1" }, "first": { "href": "https://dark.shopping/api/v1/product/list?key=2ddbf242b63f193b8e810109b6eb1d47939cdf8f&page=1" }, "last": { "href": "https://dark.shopping/api/v1/product/list?key=2ddbf242b63f193b8e810109b6eb1d47939cdf8f&page=8" }, "next": { "href": "https://dark.shopping/api/v1/product/list?key=2ddbf242b63f193b8e810109b6eb1d47939cdf8f&page=2" } }, "_meta": { "totalCount": 150, "pageCount": 8, "currentPage": 1, "perPage": 20 } } }
Просмотр товара
Информация
Метод | product/view | ||||||||||||||||||||||||||||||||||||||
Возвращает |
Объект услуги:
|
||||||||||||||||||||||||||||||||||||||
Пример URL | https://dark.shopping/api/v1/product/view?id=5&key=7dc8d2ee5cc18c81fe1d7326380fbd1e |
Параметры
Пример ответа:
{ "success": true, "data": { "id": 3863, "name" : "Lorem Dolor Keys", "miniature": "https://dark.shopping/media/products/0143f7df0dffef138edbb25d0b8a0482.jpg", "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas accumsan sed eros vel malesuada. Proin laoreet aliquet metus, sit amet laoreet diam. Nullam at dignissim enim. Aliquam malesuada auctor urna id scelerisque. Donec posuere libero in varius euismod. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Curabitur vel ante lorem. Nulla ac scelerisque felis. Maecenas lacinia non ex vel varius. ", "manual": "", "price": 533.4, "minimum_order": 2, "quantity": 19083, "purchase_counter": 38487, "view": 96512, "group": { "id": 52, "category_id": 28, "name": "Keys" }, "category": { "id": 28, "name": "Steam", "icon": "https://dark.shopping/media/no-miniature.png" }, "url": "https://dark.shopping/products/view/lorem-dolor-keys", "replacement_terms_public": "Lorem proin laoreet aliquet metus, sit amet laoreet diam." } }
Топ-100 товаров
Информация
Метод | product/top |
Возвращает | Массив объектов товара. Детали по полям ищите в следующем разделе "Просмотр товара" |
Пример URL | https://dark.shopping/api/v1/product/top?key=7dc8d2ee5cc18c81fe1d7326380fbd1e |
Параметры
key | API ключ |
Пример ответа:
{ "success": true, "data": { "items": [ { "id": 1, "name": "Ex est omnis et", "miniature": "https://dark.shopping/media/no-miniature.png", "description": "Лежавшая на дороге пыль быстро замесилась в грязь, и лошадям ежеминутно становилось тяжелее тащить бричку. Чичиков уже начинал сильно беспокоиться, не видя так долго заниматься Коробочкой? Коробочка ли, Манилова ли, хозяйственная ли жизнь, или нехозяйственная — мимо их! Не то на свете таких лиц, над отделкою которых натура недолго мудрила, не употребляла никаких мелких инструментов, как-то: напильников, буравчиков и прочего, но просто рубила со своего плеча: хватила топором раз — вышел нос, хватила в другой раз приеду, заберу и пеньку. — Так себе, — отвечал шепотом и потупив голову Алкид. — Хорошо, хорошо, — говорил Чичиков. — Право, недорого! Другой — мошенник обманет вас, продаст вам дрянь, а не Заманиловка? — Ну вот видишь, вот уж точно, как будто бы, по русскому выражению, натаскивал клещами на лошадь хомут. — И кобылы не нужно. Ну, скажите сами, — на крыльцо со свечою, которая успела уже притащить перину и, взбивши — ее с обоих боков руками, напустила целый потоп перьев по всей России от одного конца до — другого; прилагательные всех родов без дальнейшего разбора, как что — гнусно рассказывать, и во рту после вчерашнего точно эскадрон — переночевал. Представь: снилось, что меня высекли, ей-ей! и, — вообрази, кто? Вот ни за самого себя не — мечта! А в плечищах у него была лошадь какой-нибудь голубой или розовой шерсти, и тому подобную чепуху, так что он не обращал никакого внимания на то, как бы речь шла о хлебе. — Да, — отвечал Манилов, — все было пригнано плотно и как бы вдруг припомнив: — А! теперь хорошо! прощайте, матушка! Кони тронулись. Селифан был во всю стену, писанные масляными красками, — словом, все те, которых называют господами средней руки. В это время к окну индейский петух — окно же было — пятьдесят. Фенарди четыре часа вертелся мельницею. — Здесь — Ноздрев, подходя к ручке Маниловой. — — продолжал он, обращаясь к Чичикову. — Краденый, ни за самого себя не — стоит. — Ей-богу, продала. — Ну вот уж и нечестно с твоей стороны: слово дал, да и полно. — Экой ты, право, такой! с тобой, как я — тебе дал пятьдесят рублей, тут же провертел пред ними кое-что. Шарманка играла не без удовольствия взглянул на него глаза. — Это вам так показалось: он только топырится или горячится, как говорит народ. (Прим. Н. В. — Гоголя.)]] — Нет, матушка, не обижу, — говорил он, а между тем взглянул искоса на Собакевича, он ему на ярмарке — нужно домой. — Пустяки, пустяки, брат, не пущу. — Право, я боюсь на первых-то порах, чтобы как-нибудь не надул ее этот.", "manual": "", "price": 1410.2, "minimum_order": 1, "quantity": 14880, "purchase_counter": 16, "view": 5, "group": { "id": 10, "category_id": 5, "name": "Quia" }, "category": { "id": 5, "name": "Steam", "icon": "https://dark.shopping/media/no-miniature.png" }, "url": "https://dark.shopping/products/view/ex-est-omnis-et", "replacement_terms_public": "Lorem proin laoreet aliquet metus, sit amet laoreet diam." }, { "id": 2, "name": "Neque eius ut non odio", "miniature": "https://dark.shopping/media/no-miniature.png", "description": "Я знаю, что нехорошо быть пьяным. С хорошим человеком можно закусить. — А вот — не выпускал изо рта трубки не только поименно, но даже почтет за священнейший долг. Собакевич тоже сказал несколько лаконически: «И ко мне не заедешь». Ноздрев во многих местах ноги их выдавливали под собою воду, до такой степени загрязнилась, что колеса брички, захватывая ее, сделались скоро покрытыми ею, как войлоком, что значительно отяжелило экипаж; к тому лицу, к которому относятся слова, а к какому- нибудь нечаянно пришедшему третьему, даже вовсе незнакомому, от которого он даже покраснел, — напряжение что-то выразить, не совсем безгрешно и чисто, зная много разных передержек и других сюрпризов. Впрочем, бывают разные усовершенствования и изменения в мето'дах, особенно в нынешнее время; все это с выражением страха в лицах. Одна была старуха, другая молоденькая, шестнадцатилетняя, с золотистыми волосами весьма ловко и мило приглаженными на небольшой головке. Хорошенький овал лица ее круглился, как свеженькое яичко, и, подобно ему, белел какою-то прозрачною белизною, когда свежее, только что начавший жизненное поприще, числятся, однако ж, остановил, впрочем, — они увидели, точно, кузницу, осмотрели и суку — сука, точно, была слепая. Потом пошли осматривать водяную мельницу, где недоставало порхлицы, в которую попал непредвиденными судьбами, и, положивши свою морду на шею салфетки. — Какие же есть? — Анисовая, — отвечала девчонка. — Ну, так и прыскало с лица его. — И пробовать не хочу иметь. — Порфирий, Павлушка! — кричал он исступленно, обратившись к Порфирию и Павлушке, а сам схватил в руки шашек! — говорил Селифан, приподнявшись и хлыснув кнутом ленивца. — Ты знай свое дело, панталонник ты немецкий! Гнедой — почтенный конь, и Заседатель тож хороший конь… Ну, ну! что потряхиваешь ушами? Ты, дурак, слушай, коли говорят! я тебя, невежа, не стану есть. Мне лягушку — хоть сахаром облепи, не возьму ее в рукава, схватил в руки чашку с чаем и вливши туда фруктовой, повел такие речи: — У меня о святках и свиное сало будет. — Купим, купим, всего купим, и свиного сала купим. — Может быть, ты, отец мой, никогда еще не готова, — сказала хозяйка, обратясь к женщине, выходившей — на руку на сердце, — да, здесь пребудет приятность времени, — проведенного с вами! Я их знаю всех: это всё мошенники, весь — город там такой: мошенник на мошеннике сидит и мошенником погоняет. — Все христопродавцы. Один там только и есть Маниловка, а Заманиловки тут вовсе нет. Там прямо на горе увидишь — дом.", "manual": "", "price": 1352.48, "minimum_order": 3, "quantity": 10995, "purchase_counter": 15, "view": 3, "group": { "id": 20, "category_id": 9, "name": "Qui" }, "category": { "id": 9, "name": "Steam", "icon": "https://dark.shopping/media/no-miniature.png" }, "url": "https://dark.shopping/products/view/neque-eius-ut-non-odio", "replacement_terms_public": "Lorem ipsum adipiscing elit, sed do eiusmod tempor incididunt." }, { "id": 3, "name": "Et repellendus totam et", "miniature": "https://dark.shopping/media/no-miniature.png", "description": "Несколько мужиков, по обыкновению, отвечал: «О, большой, сударь, мошенник». Как в просвещенной Европе, так и останется Прометеем, а чуть немного повыше его, с Прометеем сделается такое превращение, какого и Овидий не выдумает: муха, меньше даже мухи, уничтожился в песчинку! «Да это не такая шарманка, как носят немцы. Это орган; посмотри — нарочно: вся из красного дерева. Вот я тебе — дам их в растопленное масло, отправил в рот, и устрицы тоже не возьму: я — давно уже умерли, остался один неосязаемый чувствами звук. Впрочем, — чтобы не сказать больше, чем нужно, запутается наконец сама, и кончится тем, что в трех верстах от города стоял — драгунский полк. Веришь ли, что такого помещика вовсе нет. Там прямо на стол. Герой наш, по обыкновению, зевали, сидя на лавках перед воротами в своих овчинных тулупах. Бабы с толстыми ляжками и нескончаемыми усами, Бобелину и дрозда в клетке. «Эк какую баню задал! смотри ты какой!» Тут много было посулено Ноздреву всяких нелегких и сильных желаний; попались даже и нехорошие слова. Что ж в них сидели купцы и продавали разные мелкие товары, нужные для крестьян. При этом обстоятельстве чубарому коню так понравилось новое знакомство, что он поместьев больших не имеет, ни даже ранга заметного. — Вы извините, если у нас было такое — что вредит уже обдуманному плану общего приступа, что миллионы — ружейных дул выставились в амбразуры неприступных, уходящих за- — облака крепостных стен, что взлетит, как пух, на воздух его — бессильный взвод и что теперь, желая успокоиться, ищет избрать наконец место для жительства, и что, прибывши в этот город, почел за непременный долг засвидетельствовать свое почтение первым его сановникам. Вот все, что ни за кого не почитаю, но только уже не было кирчёных стен, резных узоров и прочих затей, но все было прилично и в том числе двух каких-то дам. Потом был на вечере у вице- губернатора, на большом обеде у прокурора, у председателя палаты, у Ивана Григорьевича, — — Что ж, по моему суждению, как я — вижу, сочинитель! — Нет, ты живи по правде, когда хочешь, чтобы тебе оказывали почтение. Вот барина нашего всякой уважает, потому что были сильно изнурены. Такой — непредвиденный случай совершенно изумил его. Слезши с козел, он стал наконец отпрашиваться домой, но таким ленивым и вялым голосом, как во время печения праздничных лепешек со всякими съездами и балами; он уж в одно и то сделать», — «Да, недурно, — отвечал Чичиков, усмехнувшись, — чай, не заседатель, — а в канцелярии, положим, существует.", "manual": "", "price": 166.11, "minimum_order": 2, "quantity": 5546, "purchase_counter": 0, "view": 0, "group": { "id": 1, "category_id": 1, "name": "Dolores" }, "category": { "id": 1, "name": "Steam", "icon": "https://dark.shopping/media/no-miniature.png" }, "url": "https://dark.shopping/products/view/et-repellendus-etotam-et", "replacement_terms_public": "Lorem ipsum adipiscing elit, sed do eiusmod tempor incididunt." } ], "_links": { "self": { "href": "https://dark.shopping/api/v1/product/top?key=3acdfabf09716baedc133cb60488ed207e7ee730&page=1&per-page=100" }, "first": { "href": "https://dark.shopping/api/v1/product/top?key=3acdfabf09716baedc133cb60488ed207e7ee730&page=1&per-page=100" }, "last": { "href": "https://dark.shopping/api/v1/product/top?key=3acdfabf09716baedc133cb60488ed207e7ee730&page=1&per-page=100" } }, "_meta": { "totalCount": 3, "pageCount": 1, "currentPage": 1, "perPage": 100 } } }
Просмотр баланса
Информация
Метод | user/balance | ||||
Возвращает |
Объект баланса:
|
||||
Пример URL | https://dark.shopping/api/v1/user/balance?key=7dc8d2ee5cc18c81fe1d7326380fbd1e |
Параметры
key | API ключ |
Пример ответа:
{ "success": true, "data": { "balance": 455, "currency" : "RUB", } }
Создание заказа
Информация
Метод | order/create | ||||||||||
Возвращает |
Объект результата
Объект результата
Статус "pending" значит, что заказ всё ещё обрабатывается.
|
||||||||||
Пример URL | https://dark.shopping/api/v1/order/create?key=7dc8d2ee5cc18c81fe1d7326380fbd1e&product=1542&quantity=10 | ||||||||||
Примечение |
|
Параметры
key | API ключ |
product | ID товара |
quantity | Количество товара |
promoCode (Необязательно) | Промокод |
sendEmailCopy (boolean; Необязательно) | Отправка копии на e-mail |
Объект результата "ok":
{ "success": true, "data": { "status": "ok", "id" : 1458, "link" : "https://dark.shopping/storage/f2024b14e467833028fc1d198637c015f457de113a45e7e9c867a46c59ad1cfe.txt" } }
Объект результата "pending":
{ "success": true, "data": { "status": "pending", "id" : 1458, } }
Объекты ошибок:
{ "success": false, "data": { "name": "Not found", "message": "Товар не найден.", "code" : 0, "status": 404, } } -------------------------------------------------------------------- { "success": false, "data": { "name": "Bad request", "message": "Невозможно создать заказ. Пожалуйста, попробуйте позже.", "code" : 0, "status": 400, } } -------------------------------------------------------------------- { "success": false, "data": { "name": "Not found", "message": "Пользователь не найден.", "code" : 0, "status": 404, } } -------------------------------------------------------------------- { "success": false, "data": { "name": "Bad request", "message": "Недостаточно средств на балансе.", "code" : 0, "status": 400, } } -------------------------------------------------------------------- { "success": false, "data": { "name": "Not found", "message": "Платеж не найден.", "code" : 0, "status": 404, } } -------------------------------------------------------------------- { "success": false, "data": { "name": "Not found", "message": "Заказ не найден.", "code" : 0, "status": 404, } } -------------------------------------------------------------------- { "success": false, "data": { "name": "Bad request", "message": "Недостаточно средств на балансе.", "code" : 0, "status": 400, } } -------------------------------------------------------------------- { "success": false, "data": { "name": "Bad request", "message": "Минимальное количество: 55.", "code" : 0, "status": 400, } } -------------------------------------------------------------------- { "success": false, "data": { "name": "Bad request", "message": "Максимальное количество: 3.", "code" : 0, "status": 400, } } -------------------------------------------------------------------- { "success": false, "data": { "name": "Bad request", "message": "Выбранного количества нет в наличии. Доступно: 12.", "code" : 0, "status": 400, } } -------------------------------------------------------------------- { "success": false, "data": { "name": "Bad request", "message": "Заказ имеет статус возврат.", "code" : 0, "status": 400, } } -------------------------------------------------------------------- { "success": false, "data": { "name": "Not found", "message": "File not found.", "code" : 0, "status": 404, } } -------------------------------------------------------------------- { "success": false, "data": { "name": "Not found", "message": "Order not ready to download.", "code" : 0, "status": 404, } }
Просмотр заказа
Информация
Метод | order/download | ||
Возвращает |
Объект результата:
|
||
Пример URL | https://dark.shopping/api/v1/order/download?key=7dc8d2ee5cc18c81fe1d7326380fbd1e&id=12 |
Параметры
key | API ключ |
id | ID заказа |
Пример ответа:
{ "success": true, "data": { "link": "https://dark.shopping/storage/f2024b14e467833028fc1d198637c015f457de113a45e7e9c867a46c59ad1cfe.txt" } }