API для работы с Биллингом

Используемые термины

Биллинг - бизнес-процессы, связанные с приобретением услуг и работой с вирутальным счётом фирмы.

Контакт - рабочий профиль сотрудника, в котором указаны телефон, email, должность. У фирмы может быть несколько контактов.

Баланс - количество атисов у пользователя.

Возможности API

С помощью API Биллинг участник ATI.SU может получить информацию, содержащую:

данные о балансе контакта

Методы для работы с Биллингом

Баланс контакта

Получение текущего баланса контакта (если есть личный кошелек - баланс личного кошелька, если нет - общего)

Получает текущий баланс контакта.

get

/v1.0/balance

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

{...}

"balance":0.5,

"contactId":0,

"departmentId":0,

"firmId":0,

"isCommonWallet":false,

"operationsForbidden":false,

"walletId":0

}

{...}

Представляет модель результата операции по получению баланса кошелька.

balance: double

Текущий баланс кошелька.

contactId: int32

Идентификатор контакта

departmentId: int32

Идентификатор подразделения

firmId: int32

Идентификатор фирмы

isCommonWallet: boolean

Флаг общего кошелька

isDepartmentWallet: boolean

read only

isPersonalWallet: boolean

read only

operationsForbidden: boolean

Операции с кошельком запрещены пользователю.

walletId: int32

Идентификатор кошелька.

}

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

Загрузка...

Развернуть все Свернуть все

Загрузка...