Skip to content

API Reference

Обзор

SProduction Integration предоставляет REST API для программного управления интеграцией.

Базовый URL

https://your-domain.com/api/v1/

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

Все запросы к API требуют аутентификации через API ключ:

Authorization: Bearer YOUR_API_KEY

Основные эндпоинты

Заказы

Получить список заказов

http
GET /api/v1/orders

Параметры:

  • limit (int): Количество заказов (по умолчанию 50)
  • offset (int): Смещение (по умолчанию 0)
  • status (string): Фильтр по статусу

Ответ:

json
{
  "success": true,
  "data": [
    {
      "id": "12345",
      "status": "new",
      "total": 150.00,
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "total": 1
}

Создать заказ

http
POST /api/v1/orders

Тело запроса:

json
{
  "customer_id": "67890",
  "items": [
    {
      "product_id": "111",
      "quantity": 2,
      "price": 50.00
    }
  ],
  "shipping_address": {
    "street": "ул. Ленина, 10",
    "city": "Москва",
    "zip": "101000"
  }
}

Товары

Синхронизировать товар

http
POST /api/v1/products/sync

Тело запроса:

json
{
  "product_id": "111",
  "name": "Ноутбук Acer",
  "price": 45000.00,
  "stock_quantity": 15,
  "categories": ["электроника", "ноутбуки"]
}

Обработка ошибок

API возвращает стандартные HTTP коды ошибок:

  • 200 - Успешный запрос
  • 400 - Неверные параметры запроса
  • 401 - Ошибка аутентификации
  • 403 - Доступ запрещен
  • 404 - Ресурс не найден
  • 500 - Внутренняя ошибка сервера

Формат ошибки:

json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Неверные параметры запроса",
    "details": {
      "field": "product_id",
      "reason": "Обязательное поле"
    }
  }
}

Централизованная документация проектов SProduction