|
|
| Строка 1: |
Строка 1: |
| == Введение ==
| |
| [[Введение]] | | [[Введение]] |
|
| |
| == Регистрация приложения ==
| |
| Для того чтоб приложение могло начать работу, необходимо его зарегистировать на странице [https://dev.planfix.ru https://dev.planfix.ru]. В результате регистрации будет получены два ключа: аутентификационный ключ и ключ подписи.
| |
|
| |
|
| |
| == Пакеты запросов/ответов ==
| |
| Пакет запроса имеет следующую структуру
| |
| <source lang="xml">
| |
| <request method="{Имя_вызываемой функции}">
| |
| <account></account>
| |
| <sid></sid>
| |
| <!-- ... -->
| |
| </request>
| |
| </source>
| |
| {| class="wikitable" style="margin-top: 1em; width:100% "
| |
| !width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание
| |
| |-
| |
| |account ||string|| аккаунт на котором будет выполняться функция ||обязательное поле и присутствует во всех запросах
| |
| |-
| |
| |sid ||string(32) ||ключ сессии полученный в результате выполнения функции [[ПланФикс_API:Аутентификация|auth]] ||
| |
| |-
| |
| |}
| |
|
| |
| Пакет ответа имеет следующую струтуру
| |
| <source lang="xml">
| |
| <response status="{ok|error}">
| |
| <code>xxxx</code> <!-- присутствует если статус ошибки error -->
| |
| <!-- тело ответа -->
| |
| </response>
| |
| </source>
| |
| Все ответы на запросы списков содержат в корневом элементе два атрибута. '''totalCount''' - количество всех элементов удовлетворяющих условию, '''count''' - количество возвращенных элементов в результате. Например:
| |
| <source lang="xml">
| |
| <response status="ok">
| |
| <actions count="5" totalCount="23">
| |
| </actions>
| |
| </response>
| |
| </source>
| |
| Расшифровки кодов ошибки можно посмотреть на странице [https://api.planfix.ru/error.xml https://api.planfix.ru/error.xml]. Структура файла:
| |
| <source lang="xml">
| |
| <errors>
| |
| <code id="хххх">описание ошибки</code>
| |
| <!-- ... -->
| |
| </errors>
| |
| </source>
| |
|
| |
|
| |
| == Список функций ==
| |
| *[[ПланФикс API:Аутентификация|Аутентификация]]
| |
| *[[ПланФикс API:Проекты|Проекты]]
| |
| *[[ПланФикс API:Задачи|Задачи]]
| |
| *[[ПланФикс API:Действия|Действия]]
| |
| *[[ПланФикс API:Управление группами пользователей|Управление группами пользователей]]
| |
| *[[ПланФикс API:Сотрудники|Сотрудники]]
| |
| *[[ПланФикс API:Клиенты|Клиенты]]
| |
| *[[ПланФикс API:Контакты|Контакты]]
| |
| *[[ПланФикс API:Работа с файлами|Работа с файлами]]
| |
| *[[ПланФикс API:Лог|Лог]]
| |
|
| |
|
| |
| == Список используемых типов данных ==
| |
| *[[ПланФикс API:Тип данных int|Тип данных int]]
| |
| *[[ПланФикс API:Тип данных string|Тип данных string]]
| |
| *[[ПланФикс API:Тип данных DateTime|Тип данных DateTime]]
| |
| *[[ПланФикс API:Тип данных bool|Тип данных bool]]
| |
| *[[ПланФикс API:Тип данных enum|Тип данных enum]]
| |
|
| |
| == Смотри также ==
| |
| *[[ПланФикс API:Коды ошибок|Коды ошибок]]
| |
