ПерфектПак · API v1.1
openapi.yaml ↗
Справочник методов / Песочница

Получить тестовый ключ

POST /sandbox/keys без ключа
Адрес
POST https://api.perfektpak.ru/v1/sandbox/keys

Метод открыт: ключ не нужен.

Описание метода

Без авторизации, с лимитом по адресу. Ключ pp_test_… открывает собственную копию вымышленного селлера «ИП Ромашкина Е. В.»: два кабинета, 24 товара, приёмки, отгрузки, заказы за 30 дней. Все ручки работают как боевые; данные ни с чем не пересекаются. Состояние теряется после 24 часов без запросов. Условия — /docs/sandbox.

Авторизация

Заголовок не нужен — это единственная точка входа, которую можно вызвать без ключа.

Ответы

201 Ключ выпущен. Нигде не хранится — потеряли, возьмите новый.

Схема: SandboxKey

  • key строка
  • expires_after_idle строка
  • docs строка
429 Превышен лимит запросов — 60 в минуту на ключ, с всплеском до 20.

Схема: ErrorResponse

  • error объект Error обязательно
    поля Error
    • code строка ErrorCode обязательно
      Машинный, стабильный код ошибки — ветвитесь в коде по нему, а не по тексту message (он на русском и может измениться). unauthorized — ключ не передан или не существует; key_revoked — ключ существует, но отозван; bad_request — параметры запроса не прошли валидацию; bad_cursor — курсор не наш или испорчен (в отличие от обычного bad_request, здесь нужно перезапросить страницу заново, а не повторять тот же курсор); not_found — ресурса нет либо он принадлежит не вашему client_id (специально неразличимо); rate_limited — превышен лимит запросов; internal — ошибка на нашей стороне. С v1.1: validation_error — поле тела запроса не прошло проверку (поле названо в message); cabinet_required — у вас несколько кабинетов, укажите cabinet_id; mixed_marking — в одной заявке позиции и с маркировкой, и без, разделите на две; write_disabled — заявки через API ещё не включены для вашего ключа; warehouse_unavailable — склад временно не принял заявку, повторите через минуту (заявка не создана); webhook_url_unverified — адрес не ответил 2xx на проверочное событие; webhook_limit — больше 10 подписок; webhooks_unavailable — вебхуки временно выключены; sandbox_only — операция только для тестового ключа.
      Значения: unauthorized key_revoked rate_limited not_found bad_request bad_cursor internal validation_error cabinet_required mixed_marking write_disabled warehouse_unavailable webhook_url_unverified webhook_limit webhooks_unavailable sandbox_only
    • message строка обязательно
      Текст ошибки на русском для лога и для человека — не для ветвления в коде.
    • request_id строка обязательно
      Тот же идентификатор, что и в заголовке X-Request-Id. Присылайте его в поддержку, чтобы нашли конкретный вызов.