Документация

Справочник API

22 метода партнёрского API: поля запросов, ответы, коды отказов и примеры. У каждого метода — консоль песочницы.

База

https://api.astrum.shop/v1

Ключ — заголовком Authorization: Bearer ask_live_…, только с сервера.

Песочница

https://sandbox-api.astrum.shop/v1

Ключ ask_test_…, тестовые доллары, те же товары. Как устроена

Спецификация OpenAPI 3.1

Ключ

Партнёр, лимиты ключа и сводка вебхука одним запросом. Подробно — гайд.

GETКлюч, лимиты и партнёр/v1/me

Аванс

Баланс, леджер, адреса пополнения и зачисленные переводы. Подробно — гайд.

GETАванс, порог алерта, траты за сутки/v1/walletPATCHСвой порог алерта «аванс кончается»/v1/walletGETЛеджер аванса, новые сверху/v1/ledgerGETИменные адреса депозита (новый — через 24 ч после добавления)/v1/deposit-addressesGETЗачисленные переводы, новые сверху/v1/deposits

Каталог

Позиции по оптовым ценам, наличие без чисел. Подробно — гайд.

GETКаталог опта (кэш 1 мин)/v1/catalog

Заказы

Смета, заказ с оплатой авансом, отмена неоплаченного. Подробно — гайд.

POSTСмета по оптовым ценам/v1/orders/quotePOSTСоздать и оплатить заказ авансом/v1/ordersGETЗаказы партнёра, новые сверху/v1/ordersGETЗаказ с товаром/v1/orders/{order_id}POSTОтменить неоплаченный заказ/v1/orders/{order_id}/cancel

Активации

Что спросить у клиента, передача данных, повтор и force. Подробно — гайд.

GETСостояние активации: что спросить у клиента и что дальше/v1/activations/{activation_id}POSTПередать данные клиента/v1/activations/{activation_id}/credentialPOSTПовторить на уже переданных данных/v1/activations/{activation_id}/retryPOSTВключить поверх действующего тарифа клиента/v1/activations/{activation_id}/forcePOSTСсылка входа из письма вендора — оплата нашей картой/v1/activations/{activation_id}/login-link

События

Лента событий — то же, что приходит вебхуком. Подробно — гайд.

GETСобытия после курсора (seq)/v1/events

Вебхук

Адрес, подписка, секрет подписи и тестовое событие. Подробно — гайд.

GETНастройки и сводка доставки/v1/webhookPUTАдрес и подписка/v1/webhookPOSTНовый секрет (один раз); прежний подписывает ещё 24 ч/v1/webhook/rotate-secretPOSTТестовое событие на адрес/v1/webhook/test

Общие отказы

Их может вернуть любой метод с ключом. Свои отказы — на странице метода, реестр целиком — в разделе «Ошибки».

401unauthenticatedКлюч API не принят: нет ключа, он неверный или отозван
403scope_missingУ ключа нет нужной области
403ip_not_allowedАдрес запроса не входит в разрешённые для ключа
403account_suspendedАккаунт партнёра приостановлен — напишите в поддержку
429rate_limitedСлишком много запросов — повторите после Retry-After
503api_disabledAPI временно выключен
500internal_errorВнутренняя ошибка — повторите запрос с тем же ключом повтора