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

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

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

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

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

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

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

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

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

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

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

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

get /v1.0/balance

Модель и примеры
Консоль

Запрос

Пример запроса

CURL
1C

curl 'https://api.ati.su/v1.0/balance' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v1.0/balance");

Ответ

200 Success

Модель

{...}

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

balance: double

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

contactId: int32

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

departmentId: int32

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

firmId: int32

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

isCommonWallet: boolean

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

isDepartmentWallet: boolean

read only

isPersonalWallet: boolean

read only

operationsForbidden: boolean

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

walletId: int32

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

}

Пример

{...}

"balance":0.5,

"contactId":0,

"departmentId":0,

"firmId":0,

"isCommonWallet":false,

"operationsForbidden":false,

"walletId":0

}

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"

}