B2B документація

B2B API – автоматизоване отримання інформації про замовлення та товари

Наш REST API доступний кожному клієнту з обліковим записом клієнта та дає змогу автоматизовано отримувати інформацію про замовлення й товари та інтегрувати її у власні системи.

vpn_key Відкрити доступ до API в обліковому записі Сторінка бізнес-клієнтів

Автентифікація

Усі запити до API потребують дійсного API-Key, який надсилається в HTTP-заголовку. Доступ до API прив'язаний до вашого облікового запису клієнта та загалом доступний для облікових записів клієнтів.

info Вам не потрібна окрема B2B-заявка: увійдіть до свого облікового запису клієнта, відкрийте вкладку API та згенеруйте там свій API-Key. До доступу до API →

Формат заголовка

HTTP Request Header

X-API-Key: YOUR_API_KEY_HERE
Content-Type: application/json
Accept: application/json

Приклад з cURL

cURL

curl -X GET "https://artumos.com/api/v1/orders" \
  -H "X-API-Key: YOUR_API_KEY_HERE" \
  -H "Accept: application/json"

Base URL

Усі кінцеві точки відносні до наступного Base URL:

Base URL

https://artumos.com/api/v1

Усі відповіді повертаються як JSON (Content-Type: application/json).

Rate Limits

Plan	Запитів / хвилину	Запитів / день
Обліковий запис клієнта	60	5.000
Розширений ліміт	на запит	на запит

При перевищенні повертається HTTP 429 Too Many Requests Заголовок Retry-After містить час очікування в секундах.

Коди помилок

HTTP-Code	Значення
`200 OK`	Запит успішний
`400 Bad Request`	Недійсні параметри
`401 Unauthorized`	Відсутній або недійсний API-Key
`403 Forbidden`	Немає дозволу на цей ресурс
`404 Not Found`	Ресурс не знайдено
`429 Too Many Requests`	Перевищено Rate Limit
`500 Internal Server Error`	Помилка сервера – зверніться до підтримки

Формат відповіді про помилку

JSON

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key."
  }
}

Кінцева точка: Замовлення

GET /api/v1/orders Усі замовлення облікового запису

Parameter	Тип	Опис
`page`	integer	Сторінка (за замовчуванням: 1)
`per_page`	integer	Записів на сторінку (макс. 100)
`status`	string	`paid` \| `pending` \| `all`

Beispiel-Response

{
  "success": true,
  "data": {
    "orders": [
      {
        "id": "ORD-12345",
        "status": "paid",
        "total": 49.99,
        "currency": "EUR",
        "created_at": "2026-01-15T10:30:00Z",
        "items_count": 2
      }
    ],
    "pagination": {
      "page": 1,
      "per_page": 20,
      "total": 42
    }
  }
}

GET /api/v1/orders/{order_id} Отримати окреме замовлення

Кінцева точка: Інформація про товари та замовлення

GET /api/v1/orders/{order_id}/codes Уся інформація про товари одного замовлення

Beispiel-Response

{
  "success": true,
  "data": {
    "order_id": "ORD-12345",
    "codes": [
      {
        "id": "CODE-789",
        "product_name": "Beispielprodukt vom Marktplatz",
        "product_sku": "ART-PRODUCT-001",
        "product_info": "Hinweise laut Verkäuferangaben",
        "delivery_url": "https://...",
        "delivered_at": "2026-01-15T10:31:00Z",
        "status": "active"
      }
    ]
  }
}

GET /api/v1/codes/{code_id} Отримати окрему інформацію про товар

warning Інформацію про товари та замовлення дозволено використовувати лише в межах відповідного замовлення та відомостей продавця. Зловмисна передача може порушувати умови використання.

Кінцева точка: Товари

GET /api/v1/products Отримати каталог товарів

Parameter	Тип	Опис
`category`	string	Фільтрувати за slug категорії
`in_stock`	boolean	Лише доступні товари
`page`	integer	Сторінка

Beispiel-Response

{
  "success": true,
  "data": {
    "products": [
      {
        "id": 42,
        "sku": "ART-PRODUCT-001",
        "name": "Beispielprodukt vom Marktplatz",
        "price": 49.99,
        "currency": "EUR",
        "in_stock": true,
        "category": "handmade"
      }
    ]
  }
}

Webhooks

Webhook дають змогу отримувати сповіщення в реальному часі, коли замовлення або коди стають доступними. Webhook-URL можна вказати в обліковому записі клієнта.

Доступні події

Event	Опис
`order.paid`	Замовлення оплачено
`codes.delivered`	Коди надано
`order.refunded`	Замовлення відшкодовано

Webhook Payload

POST – Ваш Webhook-endpoint

{
  "event": "codes.delivered",
  "timestamp": "2026-01-15T10:31:05Z",
  "data": {
    "order_id": "ORD-12345",
    "codes_count": 2
  },
  "signature": "sha256=..."
}

Перевірте підпис за допомогою вашого Webhook-Secret: HMAC-SHA256(payload, webhook_secret)

Поширені запитання

Хто може користуватися B2B API?

Кожен клієнт з обліковим записом клієнта може користуватися доступом до API. Увійдіть до свого облікового запису клієнта та використовуйте відповідний API-Key для автентифікованих запитів.

Який формат мають відповіді?

Усі відповіді повертаються як JSON. Кореневий об'єкт завжди містить success: true/false а також або data або error.

Чи можу я оформляти замовлення через API?

У першій версії API служить для отримання замовлень, інформації про замовлення та товари. Кінцеві точки для запису замовлень буде активовано окремо, щойно вони стануть доступними.

Чи є середовище Sandbox?

Так. Sandbox можна активувати в обліковому записі клієнта на вкладці „Доступ до API“ і він безпосередньо прив'язаний до відповідного API-Key.