Общие принципы функционирования API — различия между версиями

Текущая версия на 22:41, 31 августа 2014

API предоставляется встроенным HTTP(S) сервером. Взаимодействие клиентского приложения с сервером происходит в виде серии GET/POST запросов. Каждый метод для работы с API определяется URL (страницей на сервере), параметрами (соответствуют параметрам GET/POST) и ответом. Ответ представляет собой текст, содержащий данные в формате XML.

Общий вид ответа в случае успеха:

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<result>ok</result>
        ...Данные...
</response>

В случае ошибки на сервере:

<?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>