Общие принципы функционирования API — различия между версиями
Материал из Wiki
ASLezhnin (обсуждение | вклад) |
|||
| Строка 5: | Строка 5: | ||
Общий вид ответа в случае успеха: | Общий вид ответа в случае успеха: | ||
| − | < | + | <syntaxhighlight lang="xml"> |
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
<response> | <response> | ||
| Строка 22: | Строка 22: | ||
<error_code>{Error num}</error_code> | <error_code>{Error num}</error_code> | ||
</response> | </response> | ||
| − | </ | + | </syntaxhighlight> |
Версия 11:03, 29 августа 2014
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>
