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 OK

Модель

double

Пример

0.5

400 Неверные входные данные.

Модель

{...}

Стандартный ответ с описанием ошибки

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"invalid_input_data",

"reason":"Неверные входные данные."

}

401 Не авторизован

Модель

{...}

Стандартный ответ с описанием ошибки

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"un_authorized",

"reason":"Не авторизован"

}

404 Ресурс не найден

Модель

{...}

Стандартный ответ с описанием ошибки

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"not_found",

"reason":"Ресурс не найден"

}

500 Произошла ошибка во время выполнения запроса.

Модель

{...}

Стандартный ответ с описанием ошибки

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"internal_error",

"reason":"Произошла ошибка во время выполнения запроса."

}

504 Сервер не ответил во время.

Модель

{...}

Стандартный ответ с описанием ошибки

error: string (nullable)

Код ошибки

reason: string (nullable)

Описание ошибки

}

Пример

{...}

"error":"timeout",

"reason":"Сервер не ответил во время."

}