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 позволяют получать уведомления в реальном времени, когда заказы или коды предоставляются. URL для Webhook можно указать в клиентском аккаунте.

Доступные события

Event	Описание
`order.paid`	Заказ был оплачен
`codes.delivered`	Коды были предоставлены
`order.refunded`	Заказ был возвращён

Webhook Payload

POST – Ваш Webhook-эндпоинт

{
  "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.