Биллинг

Пример curl-запроса на получение истории платежей и баланса пользователя:

curl --location --request GET 'http://cloud.dvor24.com/api/v2/billing/user-balance-history?userIds[]=ЛОГИН-ПОЛЬЗОВАТЕЛЯ&type=other' --header 'X-Vsaas-Api-Key: КЛЮЧ-АПИ' --header 'X-Vsaas-Session: ТОКЕН-АВТОРИЗАЦИИ'

Получение истории платежей и информации о балансе

GET/api/v2/billing/user-balance-history

Заголовки:
КлючТипОписание
x-vsaas-api-keystringApi Key пользователя
x-vsaas-sessionstringSession key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-keystringToken, сгенерированный в личном кабинете
Параметры:
КлючТипОписание
userIdsarrayпередается массив id пользователей (объектов) или массив логинов пользователей (номеров объектов)
typestringможет иметь два значения object/other в зависимости от того, какой массив передается (объектов/пользователей)
dateFromintegerдата от (UNIX time)
dateBeforeintegerдата до (UNIX time)
offsetintegerуказывает число строк, которое необходимо пропустить в общем массиве данныx
commentstringпоиск по комментарию
sumstringпоиск по сумме
limitintegerограничивает количество выходных данных
Ответ:
КлючТипОписание
resultobjectобъект с ответом сервера
successbooleanинформация о статусе запроса

Изменение баланса пользователя(-ей)

POST/api/v2/billing/user-balance-update

Заголовки:
КлючТипОписание
x-vsaas-api-keystringApi Key пользователя
x-vsaas-sessionstringSession key, для авторизованных пользователей
(ИЛИ) x-vsaas-service-api-keystringToken, сгенерированный в личном кабинете
Параметры:
КлючТипОписание
userIdsarray of objectsмассив id пользователей и значение баланса для каждого из них, если надо поменять баланс разным пользователям или id объекта, если баланс меняется для пользователей одного объекта (одинаковая сумма для всех)
userIds[].idintegerмассив id пользователей
userIds[].balanceintegerцелое значение баланса для каждого польззователя
balanceintegerцелое значение баланса для польззователей - только при изменении баланса для пользователей одного объекта, если передается id объекта
typestringusers_with_balances - если меняется баланс для списка отдельных пользователей / object - если нужно установить поменять баланс для всех пользователей объекта
Ответ:
КлючТипОписание
successbooleanинформация о статусе запроса

Пример массива, для запроса изменения баланса списка отдельных пользователей:

--body '{
    "userIds": [
        {
            "id": 12345,
            "balance": 100
        },
        {
            "id": 54321,
            "balance": 200
        }
    ],
    "type": "users_with_balances"
}'
Обратите внимание!
  • Если запрос передается в строку, в url, обязательно используйте url encode. Но лучше передавать запрос json-массивом или непосредственно в теле запроса.

Api

Справочник

Fixing

О разделе