API личного кабинета
API кабинета kosareva.cloud отдаёт баланс, ключи и счета на адресах /api/v1/. Так можно показывать остаток во внутренней панели или сверять расходы с бухгалтерией.
Запрос
Адрес https://kosareva.cloud, а не api.. Авторизация тем же ключом, что и для моделей, второй секрет заводить не нужно.
curl https://kosareva.cloud/api/v1/balance \
-H "Authorization: Bearer ВАШ_API_КЛЮЧ"
Методы
| Метод | Что возвращает |
|---|---|
GET /api/v1/me | профиль: имя, почта, тип аккаунта, компания, ИНН, скидка в процентах |
GET /api/v1/balance | пополнено, потрачено и остаток в рублях |
GET /api/v1/keys | ключи: имя, маска и лимит в рублях, без самих секретов и без расхода по ключу |
GET /api/v1/invoices | счета: номер, сумма, статус, даты |
GET /api/v1/topups | история пополнений |
Ответ
Так выглядит ответ /api/v1/balance:
{
"currency": "RUB",
"topped_up": 5000,
"spent": 1243.51,
"remaining": 3756.49
}
Все методы только читают и только ваши данные. Если ключ не передан или удалён, приходит 401 с пояснением в error.message. Пополнить баланс или создать ключ можно только в кабинете: так безопаснее, если ключ утечёт.