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

Версия от 14:01, 11 августа 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">
  <actions count="5" totalCount="23">
  </actions>
</response>

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

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

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

Смотри также

Коды ошибок

@@ Строка 39: / Строка 39: @@
 </errors>
 </source>
 == Список функций ==
@@ Строка 48: / Строка 49: @@
 *[[ПланФикс API:Сотрудники|Сотрудники]]
 *[[ПланФикс API:Клиенты|Клиенты]]
+*[[ПланФикс API:Контакты|Контакты]]
 *[[ПланФикс API:Работа с файлами|Работа с файлами]]
 *[[ПланФикс API:Лог|Лог]]
 == Смотри также ==
 *[[ПланФикс API:Коды ошибок|Коды ошибок]]

Навигация

Перейти