Общие принципы функционирования API
Материал из Wiki
Версия от 11:03, 29 августа 2014; DIZyablitsev (обсуждение | вклад)
API предоставляется встроенным HTTP(S) сервером.
Взаимодействие клиентского приложения с сервером происходит в виде серии GET/POST запросов.
Каждый метод для работы с API определяется URL (страницей на сервере), параметрами (соответствуют параметрам GET/POST) и ответом.
Ответ представляет собой текст, содержащий данные в формате XML.
Общий вид ответа в случае успеха:
<?xml version="1.0" encoding="UTF-8"?> <response> <result>ok</result> ...Данные... </response> </code> В случае ошибки на сервере: <code>[xml] <?xml version="1.0" encoding="UTF-8"?> <response> <result>error</result> <description>{Error description}</description> <error_type>{logic|system|external}</error_type> <error_code>{Error num}</error_code> </response>