API ПланФикса: различия между версиями
Seva (обсуждение | вклад) |
Seva (обсуждение | вклад) |
||
| Строка 23: | Строка 23: | ||
<code>xxxx</code> <!-- присутствует если статус ошибки error --> | <code>xxxx</code> <!-- присутствует если статус ошибки error --> | ||
<!-- тело ответа --> | <!-- тело ответа --> | ||
</response> | |||
</source> | |||
Все ответы на запросы списков содержат в корневом элементе два атрибута. '''totalCount''' - количество всех элементов удовлетворяющих условию, '''count''' - количество возвращенных элементов в результате. Например: | |||
<source lang="xml"> | |||
<respose status="{ok|error}"> | |||
<actions count="5" totalCount="23"> | |||
</actions> | |||
</response> | </response> | ||
</source> | </source> | ||
| Строка 32: | Строка 39: | ||
</errors> | </errors> | ||
</source> | </source> | ||
== Список функций == | == Список функций == | ||
Версия от 13:57, 10 августа 2010
Введение
ПланФикс API реализовываем ввиде чистого XML поверх HTTP. Все API выполняются через POST запросы. Доступ к интерфейсу осуществляется по адресу https://api.planfix.ru/xml/.
Регистрация приложения
Для того чтоб приложение могло начать работу, необходимо его зарегистировать на странице https://dev.planfix.ru. В результате регистрации будет получены два ключа: аутентификационный ключ и ключ подписи.
Пакеты запросов/ответов
Пакет запроса имеет следующую структуру
<request method="{Имя_вызываемой функции}">
<account></account> <!-- обязательное поле и присутствует во всех запросах -->
<sid></sid> <!-- ключ сессии полученный в результате выполнения функции auth -->
<!-- ... -->
</request>Пакет ответа имеет следующую струтуру
<respose status="{ok|error}">
<code>xxxx</code> <!-- присутствует если статус ошибки error -->
<!-- тело ответа -->
</response>Все ответы на запросы списков содержат в корневом элементе два атрибута. totalCount - количество всех элементов удовлетворяющих условию, count - количество возвращенных элементов в результате. Например:
<respose status="{ok|error}">
<actions count="5" totalCount="23">
</actions>
</response>Расшифровки кодов ошибки можно посмотреть на странице https://api.planfix.ru/error.xml. Структура файла:
<errors>
<code id="хххх">описание ошибки</code>
<!-- ... -->
</errors>