Документация API

Запрос

HTTP-метод: GET

Тело ответа:

success - флаг, в зависимости от успешности запроса - содержит true/false
data - содержит результат выполнения запроса. При неудачном запросе - возвращает информацию об ошибке

Успешный запрос:

{
    "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
Получить можно в настройках
(!) Не передавайте ключ третьим лицам!

Формат ответа

Доступные форматы: JSON, XML. Формат определяется в зависимости от содержимого свойства Accept в заголовке запроса.

Формат для JSON:

Accept: application/json

Формат для XML:

Accept: application/xml

Определить ответ вне зависимости от заголовка можно с помощью GET-свойства _format.
Пример: _format=json

Пагинация

Пагинация (постраничная навигация) — способ представления большого количества однотипной информации, когда контент разбивается на страницы. Например, используется в выводе списка товаров.

Пример ответа, содержащий пагинацию:

{
  "success": true,
  "data": {
    "items": [],
    "_links": {
      "self": {
        "href": "http://storedark.loc/api/v1/entity/list?key=2ddbf242b63f193b8e810109b6eb1d47939cdf8f&page=1"
      },
      "first": {
        "href": "http://storedark.loc/api/v1/entity/list?key=2ddbf242b63f193b8e810109b6eb1d47939cdf8f&page=1"
      },
      "last": {
        "href": "http://storedark.loc/api/v1/entity/list?key=2ddbf242b63f193b8e810109b6eb1d47939cdf8f&page=8"
      },
      "next": {
        "href": "http://storedark.loc/api/v1/entity/list?key=2ddbf242b63f193b8e810109b6eb1d47939cdf8f&page=2"
      }
    },
    "_meta": {
      "totalCount": 150,
      "pageCount": 8,
      "currentPage": 1,
      "perPage": 20
    }
  }

Список товаров

Основная информация

Метод	product/list
Возвращает	Массив объектов товара. Детали по полям ищите в следующем разделе "Просмотр товара"
Пример URL	https://darkstore.su/api/v1/product/list?key=7dc8d2ee5cc18c81fe1d7326380fbd1e

Параметры запроса

key

API ключ

Пример ответа:

{
"success": true,
"data": {
"items": [
{
"id": 3844,
"name": "Iure repudiandae sit et numquam",
"miniature": "https://darkstore.su/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://darkstore.su/media/no-miniature.png"
}
},
{
"id": 3845,
"name": "Voluptas saepe natus",
"miniature": "https://darkstore.su/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://darkstore.su/media/no-miniature.png"
}
},
{
"id": 3846,
"name": "Itaque ducimus non delectus adipisci",
"miniature": "https://darkstore.su/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://darkstore.su/media/no-miniature.png"
}
}
],
"_links": {
"self": {
"href": "https://darkstore.suapi/v1/product/list?key=2ddbf242b63f193b8e810109b6eb1d47939cdf8f&page=1"
},
"first": {
"href": "https://darkstore.su/api/v1/product/list?key=2ddbf242b63f193b8e810109b6eb1d47939cdf8f&page=1"
},
"last": {
"href": "https://darkstore.su/api/v1/product/list?key=2ddbf242b63f193b8e810109b6eb1d47939cdf8f&page=8"
},
"next": {
"href": "https://darkstore.su/api/v1/product/list?key=2ddbf242b63f193b8e810109b6eb1d47939cdf8f&page=2"
}
},
"_meta": {
"totalCount": 150,
"pageCount": 8,
"currentPage": 1,
"perPage": 20
}
}
}

Просмотр товара

Информация

Метод

product/view

Возвращает

Объект услуги:

ID Товара

miniature

URL изображения товара

description

Описание товара
[!] Может содержать HTML-код

manual

Рекомендации по использованию товара. Следует размещать рядом с описанием.
[!] Может содержать HTML-код

price

Стоимость за 1 единицу

minimum_order

Число минимального размера заказа

quantity

Доступное число к покупке

purchase_counter

Число покупок

view

Число просмотров

group

id	ID группы
category_id	ID категории, в которой находится группа
name	Название группы

Параметры

id	ID товара
key	API ключ

Пример ответа:

{
  "success": true,
  "data":     {
      "id": 3863,
      "name" : "Lorem Dolor Keys",
      "miniature": "https://darkstore.su/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://darkstore.su/media/no-miniature.png"
      }
    }
}

Навигация

Запрос

Аутентификация

Формат ответа

Пагинация

Список товаров

Основная информация

Параметры запроса

Пример ответа:

Просмотр товара

Информация

Параметры

Пример ответа: