Перейти до основного вмісту

Авторизація та обмеження

Отримати API ключ можна в розділі Інтеграції (Integrations).

Основні можливості

  • Керування рахунками: створення, скасування, перевірка статусу
  • Керування платежами: список платежів, прив’язка платежу до рахунку
  • Статистика: отримання агрегованих даних за проєктами, за періодами, за гаманцями тощо
  • Білінг: тарифи за проєктами, баланси

Обмеження

  • Кількість запитів: не більше ніж 1 запит на секунду на один ключ
  • Кількість ключів: 10 на один акаунт

Авторизація запитів

Для авторизації кожного запиту до API в заголовку Authorization потрібно передати ваш API ключ.

Приклад використання заголовка Authorization у запиті до API:

curl -X POST https://api.bitsby.app/invoices/list \
-H "Authorization: Token MSvL2ltaDZdWVjmZURURMVWhqSJLT2NURjhL2Fla1Z1T1IxQTltKs1T3Ay"

Відповідь сервера

Відповідь сервера API завжди надходить у форматі JSON. Орієнтуйтеся на параметр result для визначення успішності результату запиту.

Приклад відповіді сервера в разі позитивного результату запиту:

{
"result": "success",
"data": .....
}

Приклад відповіді сервера в разі помилки:

{
"result": "error",
"data": "Requests too frequent"
}