Коды пополнения
MarkdownМетоды, поля запросов и ответы.
Полное руководство
В разделе 2 методов. Откройте метод, чтобы посмотреть условия доступа, поля запроса и ответ.
| Метод и путь | Описание | Доступ |
|---|---|---|
POST /api/v1/redeem | Погашение кода | Токен кабинета |
GET /api/v1/redeem/history | История погашений | Токен кабинета |
POST /api/v1/redeem — Погашение кода
Доступ: Токен кабинета
/api/v1/redeemПоля JSON / формы
| Поле | Тип | Обязательно | Проверка / описание |
|---|---|---|---|
code | string | да | required |
{
"code": "PLACEHOLDER_CODE (string)"
}PLACEHOLDER обозначает ваш ввод и его тип. Замените значения и оставьте только нужные необязательные поля; строковые маркеры не отправляются вместо чисел, boolean, объектов или массивов.
Схема запроса: RedeemRequest
Ответ
JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.
Схемы данных ответа: RedeemCode. Поля и типы — на страницах «Схемы данных».
{
"code": 0,
"message": "success",
"data": {
"id": "PLACEHOLDER_ID (integer)",
"code": "PLACEHOLDER_CODE (string)",
"type": "PLACEHOLDER_TYPE (string)",
"value": "PLACEHOLDER_VALUE (number)",
"status": "PLACEHOLDER_STATUS (string)",
"used_by": "PLACEHOLDER_USED_BY (integer)",
"used_at": "PLACEHOLDER_USED_AT (string)",
"created_at": "PLACEHOLDER_CREATED_AT (string)",
"expires_at": "PLACEHOLDER_EXPIRES_AT (string)",
"validity_days": "PLACEHOLDER_VALIDITY_DAYS (integer)",
"notes": "PLACEHOLDER_NOTES (string)",
"user": "PLACEHOLDER_USER (object)"
}
}Особенности: Все личные данные и объекты ограничены субъектом JWT.
Особенности: Операция изменяет состояние или продолжает одноразовую авторизацию; пример описывает контракт и не выполняется.
GET /api/v1/redeem/history — История погашений
Доступ: Токен кабинета
/api/v1/redeem/historycurl --fail-with-body "https://ailoot.ai/api/v1/redeem/history" \
-H "Authorization: Bearer $TOKEN"Query-параметры
| Поле | Тип | Обязательно | Проверка / описание |
|---|---|---|---|
page | integer | нет | ; по умолчанию: 1; positive integer |
page_size | integer | нет | ; по умолчанию: 20; positive; clamp to100 |
Тело запроса не требуется. Передавайте указанные выше параметры в URL.
Ответ
JSON-ответ содержит code, message и data. Содержимое data описано в схемах ниже.
Схемы данных ответа: RedeemCode. Поля и типы — на страницах «Схемы данных».
{
"code": 0,
"message": "success",
"data": {
"items": [
{
"id": "PLACEHOLDER_ID (integer)",
"code": "PLACEHOLDER_CODE (string)",
"type": "PLACEHOLDER_TYPE (string)",
"value": "PLACEHOLDER_VALUE (number)",
"status": "PLACEHOLDER_STATUS (string)",
"used_by": "PLACEHOLDER_USED_BY (integer)",
"used_at": "PLACEHOLDER_USED_AT (string)",
"created_at": "PLACEHOLDER_CREATED_AT (string)",
"expires_at": "PLACEHOLDER_EXPIRES_AT (string)",
"validity_days": "PLACEHOLDER_VALIDITY_DAYS (integer)",
"notes": "PLACEHOLDER_NOTES (string)",
"user": "PLACEHOLDER_USER (object)"
}
],
"total": "PLACEHOLDER_TOTAL (integer)",
"page": "PLACEHOLDER_PAGE (integer)",
"page_size": "PLACEHOLDER_PAGE_SIZE (integer)",
"pages": "PLACEHOLDER_PAGES (integer)"
}
}Особенности: Все личные данные и объекты ограничены субъектом JWT.