Универсальное API: различия между версиями

Материал из WiKi - UserSide
Нет описания правки
Нет описания правки
Строка 5: Строка 5:


Текущая версия: 1.2 от 25.10.2015
Текущая версия: 1.2 от 25.10.2015
На данный момент работу по этому API поддерживают биллинги:
uBilling v.0.7.2+
MikBill v.2.8.16+
Вводные:
1. Всё взаимодействие построено на API RESTful-запросах
2. Рабочая кодировка – UTF-8
3. Формат данных с ответами – JSON
4. Дата выводится в формате «ГГГГ-ММ-ДД чч:мм:сс»
5. В качестве идентификации используется API-ключ
6. Дополнительно рекомендуется на уровне API биллинга настраивать и проверять IP-адрес хоста, откуда поступают запросы либо ограничивать доступ vlan`ами
7. На неподдерживаемые методы (или методы без необходимых параметров) необходимо отвечать HTTP-400 статусом через header. В тексте 400-ответа можно раширенно отвечать о характере ошибки.
8. Текстовые поля, которые имеют пустое значение – рекомендуется не возвращать вовсе (для экономии трафика)

Версия от 14:58, 22 ноября 2015

Совместно с разработчиками ряда биллингов было создана структура универсального API, которое позволяет удобно и стандартизировано получать информацию из различных биллинговых систем.

С документом можно ознакомится по ссылке http://userside.eu/main/files/API_Billing_v1_2.docx

Текущая версия: 1.2 от 25.10.2015

На данный момент работу по этому API поддерживают биллинги:

uBilling v.0.7.2+
MikBill v.2.8.16+

Вводные: 1. Всё взаимодействие построено на API RESTful-запросах 2. Рабочая кодировка – UTF-8 3. Формат данных с ответами – JSON 4. Дата выводится в формате «ГГГГ-ММ-ДД чч:мм:сс» 5. В качестве идентификации используется API-ключ 6. Дополнительно рекомендуется на уровне API биллинга настраивать и проверять IP-адрес хоста, откуда поступают запросы либо ограничивать доступ vlan`ами 7. На неподдерживаемые методы (или методы без необходимых параметров) необходимо отвечать HTTP-400 статусом через header. В тексте 400-ответа можно раширенно отвечать о характере ошибки. 8. Текстовые поля, которые имеют пустое значение – рекомендуется не возвращать вовсе (для экономии трафика)