Общая информация

Основные возможности

• Управление счетами: создание, отмена, проверка статуса

• Управление платежами: список платежей, привязка платежа к счету

• Статистика: получение агрегированных данных по проектам, по периодам, по кошелькам и пр.

API ключ

• Получить API ключ можно в разделе Интеграции

• Область действия ключа: доступ ко всем данным в вашем личном кабинете

• В будущем мы доработаем функционал API и внедрим следующие настройки: область действия ключей, замена/удаление/создание нескольких ключей в разработке

Ограничения

• На количество запросов: не более 1 запроса в секунду

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

Для авторизации каждого запроса к 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"
}