API ПланФикса

Введение

ПланФикс API реализовано в виде чистого XML поверх HTTP. Все API выполняются через POST запросы. Доступ к интерфейсу осуществляется по адресу https://api.planfix.ru/xml/.

Регистрация приложения

Для того чтоб приложение могло начать работу, необходимо его зарегистировать на странице https://dev.planfix.ru. В результате регистрации будет получены два ключа: аутентификационный ключ и ключ подписи.

Пакеты запросов/ответов

Пакет запроса имеет следующую структуру

<request method="{Имя_вызываемой функции}">
  <account></account> 
  <sid></sid> 
  <!-- ... -->
</request>

Название	Тип	Значение	Примечание
account	string	аккаунт на котором будет выполняться функция	обязательное поле и присутствует во всех запросах
sid	string(32)	ключ сессии полученный в результате выполнения функции auth

Пакет ответа имеет следующую струтуру

<response status="{ok|error}">
  <code>xxxx</code> <!-- присутствует если статус ошибки error -->
  <!-- тело ответа -->
</response>

Все ответы на запросы списков содержат в корневом элементе два атрибута. totalCount - количество всех элементов удовлетворяющих условию, count - количество возвращенных элементов в результате. Например:

<response status="ok">
  <actions count="5" totalCount="23">
  </actions>
</response>

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

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

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

• Аутентификация
• Проекты
• Задачи
• Действия
• Управление группами пользователей
• Сотрудники
• Клиенты
• Контакты
• Работа с файлами
• Лог

Список используемых типов данных

• Тип данных int
• Тип данных string
• Тип данных DateTime
• Тип данных bool
• Тип данных enum

Смотри также

• Коды ошибок