Общие принципы функционирования API — различия между версиями
Материал из Wiki
ASLezhnin (обсуждение | вклад) (Новая страница: «API предоставляется встроенным HTTP серверером») |
ASLezhnin (обсуждение | вклад) |
||
| Строка 1: | Строка 1: | ||
| − | API предоставляется встроенным HTTP | + | API предоставляется встроенным HTTP(S) сервером. |
| + | Взаимодействие клиентского приложения с сервером происходит в виде серии GET/POST запросов. | ||
| + | Каждый метод для работы с API определяется URL (страницей на сервере), параметрами (соответствуют параметрам GET/POST) и ответом. | ||
| + | Ответ представляет собой текст, содержащий данные в формате XML.<br> | ||
| + | |||
| + | Общий вид ответа в случае успеха: | ||
| + | <code>[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> | ||
| + | </code> | ||
Версия 10:14, 29 августа 2014
API предоставляется встроенным HTTP(S) сервером.
Взаимодействие клиентского приложения с сервером происходит в виде серии GET/POST запросов.
Каждый метод для работы с API определяется URL (страницей на сервере), параметрами (соответствуют параметрам GET/POST) и ответом.
Ответ представляет собой текст, содержащий данные в формате XML.
Общий вид ответа в случае успеха:
[xml]
<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>ok</result>
...Данные...
</response>
В случае ошибки на сервере:
[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>
