Документация v2.0
OVO API Reference
OVO API организован на основе REST. Наш API использует стандартные HTTP методы, принимает запросы в формате JSON и возвращает ответы в JSON. Все ответы сопровождаются стандартными HTTP-статусами.
Base URL
https://api.ovo.am/v2/
Авторизация
Вы аутентифицируетесь в OVO API, предоставляя один из ваших секретных ключей (Secret Key) в заголовке запроса. Управлять ключами можно в Панели управления.
Передавайте ключ в заголовке Authorization используя схему Bearer:
cURL
curl https://api.ovo.am/v2/products \
-H "Authorization: Bearer sk_live_your_secret_key"
Ваши ключи API дают полные права на действия с аккаунтом. Не публикуйте ключи в публичных репозиториях GitHub или клиентском коде (браузере/приложениях).
GET
/v2/products
Возвращает массив объектов (список товаров) с поддержкой пагинации.
Query Parameters
| Parameter | Description |
|---|---|
|
limit
integer, optional
|
Лимит возвращаемых объектов. Значение по умолчанию: 10. Максимум: 100.
|
|
category_id
string, optional
|
Отфильтровать товары по идентификатору конкретной категории. |
|
in_stock
boolean, optional
|
Если true, вернет только товары в наличии.
|
const ovo = require('@ovo/sdk')('sk_live_...');
const products = await ovo.products.list({
limit: 3,
in_stock: true
});
/* Возвращает:
{
"object": "list",
"data": [
{ "id": "prod_1", "name": "Hoodie", "price": 8900 ... },
...
],
"has_more": true
}
*/
POST
/v2/products
Создает новый объект товара в вашем магазине.
Body Parameters
| Parameter | Description |
|---|---|
|
name *
string, required
|
Название товара. Будет отображаться на витрине. |
|
price *
integer, required
|
Цена товара в минимальных единицах валюты (например, центах). 1000 = $10.00. |
|
currency *
string, required
|
Трехбуквенный ISO код валюты (например, usd, eur).
|
|
stock_quantity
integer, optional
|
Количество на складе. По умолчанию 0.
|
const product = await ovo.products.create({
name: 'T-Shirt Base',
price: 2500,
currency: 'usd',
stock_quantity: 100
});