Огляд

Огляд

Інтерактивний довідник API Voodoo Center

View as 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 стосується лише браузерів.