API ПланФикса: различия между версиями

Версия от 14:21, 6 августа 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>

Расшифровки кодов ошибки можно посмотреть на странице https://api.planfix.ru/error.xml. Структура файла:

<errors>
  <code id="хххх">описание ошибки</code>
  <!-- ... -->
</errors>

Список функций

Смотри также

Коды ошибок

@@ Строка 3: / Строка 3: @@
 Все API выполняются через POST запросы.
 Доступ к интерфейсу осуществляется по адресу '''https://api.planfix.ru/xml/'''.
 == Регистрация приложения ==
@@ Строка 31: / Строка 32: @@
 </errors>
 </source>
 == Список функций ==
 *[[ПланФикс API:Аутентификация|Аутентификация]]
 *[[ПланФикс API:Проекты|Проекты]]
+== Смотри также ==
+*[[ПланФикс API:Коды ошибок|Коды ошибок]]

Навигация

Перейти