Введение — различия между версиями
Seva (обсуждение | вклад) (→Формат запросов/ответов) |
SliZzzZ (обсуждение | вклад) (→Регистрация приложения) |
||
| Строка 1: | Строка 1: | ||
== Регистрация приложения == | == Регистрация приложения == | ||
| − | Для того, чтобы приложение смогло начать работу, необходимо его | + | Для того, чтобы приложение смогло начать работу, необходимо его зарегистрировать на странице '''http://dev.planfix.ru'''. |
В результате регистрации будет получены два ключа: аутентификационный ключ и ключ подписи. | В результате регистрации будет получены два ключа: аутентификационный ключ и ключ подписи. | ||
| − | |||
== Доступ к интерфейсам == | == Доступ к интерфейсам == | ||
Версия 22:08, 13 марта 2011
Содержание
Регистрация приложения
Для того, чтобы приложение смогло начать работу, необходимо его зарегистрировать на странице http://dev.planfix.ru.
В результате регистрации будет получены два ключа: аутентификационный ключ и ключ подписи.
Доступ к интерфейсам
Доступ к интерфейсу осуществляется через единственную точку входа, находящуюся по адресу: https://api.planfix.ru/xml/.
Обратите внимание, что доступ к интерфейсу осуществляется по протоколу HTTPS. Все запросы, использующие незащищенное соединение, будут автоматически игнорироваться, поэтому мы рекомендуем устанавливать тестовое безопасное соединение с точкой доступа к интерфейсам ПланФикс перед отправкой данных.
Все API выполняются через POST запросы.
Ограничения по запросам от приложения
По-умолчанию, все аккаунты имеют ограничение в 5000 запросов в сутки. Также, для методов, которые возвращают списки значений, установлено ограничение в размере 100 результатов за один запрос.
Формат запросов/ответов
Пакет запроса имеет следующую структуру
<?xml version="1.0" encoding="UTF-8"?>
<request method="{Имя_вызываемой функции}">
<account></account>
<sid></sid>
<!-- ... -->
</request>| Название | Тип | Значение | Примечание |
|---|---|---|---|
| account | string | аккаунт на котором будет выполняться функция | обязательное поле и присутствует во всех запросах |
| sid | string(32) | ключ сессии полученный в результате выполнения функции auth |
Каждый запрос должен включать заголовок HTTP авторизации. В качестве имени пользователя используется APIKey, в качестве пароля может передаваться всё, что угодно - этот параметр игнорируется. Пример:
curl -H 'Accept: application/xml' -H 'Content-Type: application/xml' \
-u 4db09df5a62a8a32a9522fcac02d3c6f:X -k -d '<request>...</request>' https://api.planfix.ru/xml/
Пакет ответа имеет следующую структуру:
<?xml version="1.0" encoding="UTF-8"?>
<response status="{ok|error}">
<code>xxxx</code> <!-- присутствует если статус ошибки error -->
<!-- тело ответа -->
</response>Все ответы на запросы списков содержат в корневом элементе два атрибута. totalCount - количество всех элементов удовлетворяющих условию, count - количество возвращенных элементов в результате. Например:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<actions count="5" totalCount="23">
</actions>
</response>Структура ответа с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>