Обзор

Обзор

Интерактивный справочник API Voodoo Center

Просмотр в формате Markdown

Этот раздел — полный интерактивный справочник API Voodoo Center, сгенерированный из нашей спецификации OpenAPI. Каждый эндпоинт перечисляет свои параметры, схемы запроса и ответа, примеры полезной нагрузки и API Explorer, с помощью которого вы можете отправлять реальные запросы.

Эндпоинты

Программный API имеет три эндпоинта, а также эндпоинт обмена токена, используемый для аутентификации:

МетодПутьНазначение
POST/api/v1/auth/token/clientОбмен API-ключа ak_ на Bearer-токен.
GET/api/v1/account/balanceПрочитать доступный для трат баланс.
POST/api/v1/ordersРазместить заказ (списывает баланс, возвращает pending).
GET/api/v1/orders/{id}Получить один из своих заказов.

Справочник также документирует исходящий webhook статуса заказа, который Voodoo Center отправляет на ваш URL, когда заказ завершается. Детали проверки см. в руководстве по Webhooks.

Аутентификация API Explorer — введите только свой API-ключ

Explorer обрабатывает аутентификацию за вас. Вы предоставляете только свой API-ключ ak_; он получает токен доступа автоматически.

1

Введите свой API-ключ

Откройте панель авторизации и вставьте свой API-ключ ak_. Это единственные учётные данные, которые вы предоставляете — никакой JWT вставлять не нужно.

2

Запустите любой эндпоинт

Когда вы отправляете запрос, Explorer сначала вызывает POST /api/v1/auth/token/client с вашим ключом, а затем использует полученный access_token как Authorization: Bearer <token> в вызове. Сам эндпоинт обмена токена публичный, поэтому не требует авторизации.

3

Продолжайте

Токены доступа действуют 2 часа; Explorer прозрачно повторно обменивает ваш ключ по мере необходимости, поэтому вы можете и дальше пробовать эндпоинты, ничего не вводя повторно.

«Try it» в браузере и CORS. Explorer в браузере работает на docs.voodoo.center, который внесён в белый список в CORS-политике API — поэтому его живые запросы (включая обмен токена) доходят до API прямо из вашего браузера. cURL и вызовы со стороны сервера с вашего собственного бэкенда это не затрагивает, поскольку CORS касается только браузеров.