Sandbox в Seller API: новые возможности для интеграций

Sandbox (песочница) – это изолированная тестовая среда Ozon, предназначенная для отработки методов Ozon Доставки для продавцов в Seller API без риска повлиять на реальные данные. В песочнице можно безопасно тестировать, экспериментировать и проверять работу приложений, не затрагивая данные продуктивной среды и избегая негативных последствий для магазина и сервисов.

• Изменения, выполняемые в песочнице, недоступны для покупателей.
• Доступ к Sandbox предоставляется бесплатно и не ограничен по времени.
• Авторизация в песочнице осуществляется по протоколу OAuth 2.0 (Client Credentials Flow). Подробный порядок получения доступа описан в Шаге 3.

Важно: в текущей версии Sandbox поддерживает тестирование сценариев Ozon Доставки (управление остатками на складах, создание и отмена заказов, работа с постингами). Использовать Sandbox можно свободно, однако для работы этих методов в продуктивной среде подключение Ozon Доставки является обязательным условием.

Как получить доступ к Sandbox

Для начала работы требуется наличие следующих учетных записей и прав:

• Личный аккаунт в Ozon (регистрация выполняется на ozon.ru).
• Аккаунт продавца на seller.ozon.ru с правами на создание частных приложений. Порядок предоставления доступа описан в статье.
• Учетная запись на портале dev.ozon.ru.

Дальнейшие шаги включают:

• Создание приложения или получение доступа к нему.
• Получение идентификаторов приложения в продуктовой среде.
• Получение токена авторизации access_token.
• Выполнение запросов к Seller API для получения данных о товарах и заказах.

Ниже приведен подробный порядок действий.

Шаг 1. Создание приложения

На портале dev.ozon.ru создается публичное (коммерческое) приложение или открывается существующее частное приложение.

• Частное приложение создаётся сразу с доступом к Sandbox.
• Коммерческое приложение должно находиться в статусе «Проверено» или выше — только после этого открывается доступ к системным настройкам. Подробная информация о коммерческих приложениях приведена в статье.

Шаг 2. Переход к системным настройкам

В списке коммерческих или частных приложений необходимо выбрать целевое приложение и перейти в раздел «Системные настройки».

На данной странице отображаются идентификаторы для доступа к песочнице:

• client_id – идентификатор приложения, общий для прод-среды и Sandbox;
• client_secret (sandbox)– секрет приложения для доступа к песочнице.

Шаг 3. Получите данные для авторизации

• Значения client_id и client_secret (sandbox) используются для запроса access-токена, предоставляющего доступ к API песочницы.
• Авторизация в Sandbox выполняется по протоколу OAuth 2.0 Client Credentials Flow — межсерверному механизму, при котором взаимодействие приложения с API происходит без участия пользователя.

Для получения access_token отправляется POST-запрос следующего вида: 

curl --location 'https://api-seller-sandbox.ozon.ru/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Accept: application/json' \
--data-urlencode 'client_id=CLIENT_ID' \
--data-urlencode 'client_secret=SECRET' \
--data-urlencode 'grant_type=client_credentials'

Эндпоинт

POST https://api-seller-sandbox.ozon.ru/oauth/token

В запросе в Header

Content-Type: x-www-form-urlencoded Accept: application/json

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

Токен запрашивается в формате application/x-www-form-urlencoded.

{
    "client_id": "ВАШ_CLIENT_ID_из приложения",
    "client_secret": "ВАШ_CLIENT_SECRET_ДЛЯ_ПЕСОЧНИЦЫ_из_приложения",
    "grant_type": "client_credentials"
}

В ответе (HTTP status 200 OK) возвращается access_token: 

{
    "access_token": "eyJhbGciOiJSUzUxMiIsImtpZCI6IjVrLzc2NDkzaDI0SCIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJ...", -- 
    "expires_in": "15552000",
    "refresh_token": "",
    "scope": ["sandbox-api.Admin"],
    "token_type": "bearer"
}

Шаг 4. Пример запроса к Seller API

После успешного получения access-токена выполняется POST-запрос к методу /v3/product/list с передачей заголовка Authorization: Bearer <access_token>. В ответе возвращается список тестовых товаров с идентификаторами product_id, offer_id и sku, необходимыми для вызова остальных методов Seller API.

curl -X POST https://api-seller-sandbox.ozon.ru/v3/product/list \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{"filter":{},"limit":10}'

Дополнительная информация о доступных методах и работе в песочнице представлена на странице документации.

Полезные ссылки

Подробная информация о методах Seller API доступна на странице документации.

Сведения о работе с приложениями приведены на странице Application API.