RIMEKS Public API
Справочник публичных методов: параметры, схемы данных и примеры ответов. Сценарии интеграции описаны в руководствах по заказам и ответственному хранению.
Адреса и окружения
Полный URL — адрес сервера на этой странице плюс путь метода. Префикс сервиса уже включён в путь; значения параметров в фигурных скобках нужно подставить перед запросом.
Доступные окружения указаны в обзорах b2b-orders и responsible-storage.
Авторизация
Создайте авторизационный токен на странице Токены интеграций. Скопируйте выданное значение и передавайте его в каждом запросе:
Code
В Try It вставьте значение токена в поле Bearer-токена. Одно поле используется для обоих сервисов; доступные методы и клиенты определяются правами токена и его владельца.
Если у токена указан срок действия, после его окончания создайте новый на странице токенов и обновите значение в интеграции. Отозванный токен использовать нельзя независимо от срока. Если нужная организация или права недоступны, обратитесь в поддержку.
Права зарегистрированного API-токена
| Операции | Разрешение |
|---|---|
| Публичные GET обоих сервисов, включая резервы и отгрузки | orders:read |
| Создание и изменение заказов, отгрузок, инвентаризаций, вебхука и возвратов; подтверждение и выкуп возврата | orders:write |
DELETE и POST /returns/{return_order_id}/cancel | orders:delete |
Разрешения складываются: токен может содержать одновременно orders:read и orders:write. Проверка права на конкретного клиента выполняется отдельно. Не используйте административные права для обычной интеграции.
При 401 проверьте передачу, срок действия и отзыв токена. При 403 проверьте разрешение метода и доступ владельца к клиенту; повтор того же запроса без изменения доступа не поможет. Для интеграции используйте токен, созданный на указанной странице.
Идентификатор клиента
Передавайте свой идентификатор клиента, связанный с вашим доступом:
- В b2b-orders — в заголовке
X-Client-ID. - В responsible-storage — в заголовке
X-Client-ID.
Передавайте один непустой X-Client-ID. Идентификатор не заменяет авторизацию: владелец токена должен иметь доступ к этому клиенту. Не передавайте несколько значений заголовка или список через запятую. В старых маршрутах responsible-storage при одновременной передаче client_id и заголовка значения должны совпадать, иначе возвращается 400.
Форматы данных
- Для запросов с JSON указывайте
Content-Type: application/json. Тип ответа проверяйте поContent-Type: не все методы возвращают JSON. - Сохраняйте типы идентификаторов из схемы. Преобразование строк в числа может удалить ведущие нули.
- Кодируйте специальные символы в пути и query-параметрах.
- Единицы денежных полей, форматы дат и допустимые значения смотрите в схеме метода.
Списки и пагинация
Страницы нумеруются с 1. Размер страницы задаётся через per_page или perPage, сортировка — через order_by / sort либо sort_by. Имена, значения по умолчанию и ограничения указаны в параметрах метода.
Метаданные ответа находятся в pagination или pages; имя массива данных зависит от метода. Особенности пустой выборки и режимы без пагинации описаны отдельно у соответствующих методов.
Обработка и повторы
Ответ 2xx не всегда означает завершение заявки. Сохраните её идентификатор и проверяйте статус через GET; учитывайте также статусы товаров и готовность документов.
Промежуточные статусы могут не попасть в ответ очередного опроса. Неизвестное значение не считайте успешным завершением.
После таймаута или 5xx сначала проверьте результат предыдущего запроса. Повтор создания, подтверждения или выкупа может повторно изменить данные. Особенности повторных вызовов указаны у методов.
При 429 уменьшите частоту запросов и используйте ограниченные повторы с увеличивающейся задержкой. В основном responsible-storage действует лимит на email: запас до 50 запросов с пополнением по одному запросу в секунду внутри экземпляра сервиса. Это не постоянные 50 запросов в секунду; шлюз может применять дополнительные ограничения.
Перед обновлением проверьте, заменяет ли запрос весь состав товаров. Ошибки обрабатывайте по HTTP-коду и телу ответа: их форматы различаются между сервисами.
Try It
Try It отправляет реальные запросы. Перед вызовом проверьте сервер, окружение, клиента и тело запроса.
OpenAPI
Скачать объединённую спецификацию в YAML для импорта в API-клиенты и генераторы кода.