Пример 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-key | string | Api Key пользователя |
| x-vsaas-session | string | Session key, для авторизованных пользователей |
| (ИЛИ) x-vsaas-service-api-key | string | Token, сгенерированный в личном кабинете |
Параметры:| Ключ | Тип | Описание |
|---|
| userIds | array | передается массив id пользователей (объектов) или массив логинов пользователей (номеров объектов) |
| type | string | может иметь два значения object/other в зависимости от того, какой массив передается (объектов/пользователей) |
| dateFrom | integer | дата от (UNIX time) |
| dateBefore | integer | дата до (UNIX time) |
| offset | integer | указывает число строк, которое необходимо пропустить в общем массиве данныx |
| comment | string | поиск по комментарию |
| sum | string | поиск по сумме |
| limit | integer | ограничивает количество выходных данных |
Ответ:| Ключ | Тип | Описание |
|---|
| result | object | объект с ответом сервера |
| id | integer | идентификатор пользователя |
| login | integer | логин пользователя |
| balance | float | текущий баланс пользователя |
| date_update_balance | integer | дата в UNIX Time |
| details | object | объект с исторей записей |
| historyPayments | array | массив записей |
| id | integer | идентификатор записи |
| sum | integer | сумма пополнения или списания с баланса |
| date | integer | дата создания записи |
| comment | integer | комментарий записи |
| type_history | string | тип списания либо пополнения |
| success | boolean | информация о статусе запроса |
POST/api/v2/billing/user-balance-history
Заголовки:| Ключ | Тип | Описание |
|---|
| x-vsaas-api-key | string | Api Key пользователя |
| x-vsaas-session | string | Session key, для авторизованных пользователей |
| (ИЛИ) x-vsaas-service-api-key | string | Token, сгенерированный в личном кабинете |
Параметры:| Ключ | Тип | Описание |
|---|
| userIds | array | передается массив id пользователей (объектов) или массив логинов пользователей (номеров объектов) |
| type | string | может иметь два значения object/other в зависимости от того, какой массив передается (объектов/пользователей) |
| balance | float | сумма, которой должен быть равен баланс |
Ответ:| Ключ | Тип | Описание |
|---|
| success | boolean | информация о статусе запроса |