Для интеграции BGBilling с внешними сайтами или стороним Личным кабинетом, возможно использование механизм Web API (доступен с версии 6.2)
Для активации данного API в конфигурации ядра необходимо прописать
Блок кода | ||
---|---|---|
| ||
web.api.enable= |
...
true |
После активации, будeт доступны два режима получения данных из BGBIlling:
- в XML формате (http://host[:port]/bgbilling/xmlWebApi/<operation>)
- в JSON формате (http://host[:port]/bgbilling/jsonWebApi/<operation>)
где <operation> это:
для Ядра
- login
- contractParameters
- contractBalance
- contractPayments
- lastContractPayments
- contractTarifPlans
- contractTariffOptions
- contractModules
для других модулей - в разработке, дополнительная информация по запросу на e-mail (http://bgbilling.ru) или на форуме
Операция login
пример запроса - /xmlWebApi/login?login=kirill&password=******[&midAuth=0] или /jsonWebApi/login?login=kirill&password=******[&midAuth=0]
ответы:
Programlisting |
---|
<response><status>Ok</status><contractId>386010</contractId><contractTitle>kirill</contractTitle></response> |
Programlisting |
---|
{"contractTitle":"kirill","contractId":386010,"status":"Ok"} |