Json-RPC API
============


API пользователя и приложения
-----------------------------


Имеется два типа доступа к API:

### API приложения[¶](#application-api "Ссылка на этот заголовок")

-   Доступ к API осуществляется с использованием пользователя “jsonrpc” и ключа, доступного в настройках
-   Доступ ко всем процедурам
-   Не проверяются права доступа
-   Нет пользовательской сессии на сервере
-   Этот доступ можно использовать для: утилит миграции/импорта данных, создания задач из других систем и т.д.

### API пользователя[¶](#user-api "Ссылка на этот заголовок")

-   Доступ к API под пользовательскими учетными данными (имя пользователя и пароль)
-   Доступ к ограниченному набору процедур
-   Проверка прав доступа к проекту
-   На сервере создается пользовательская сессия
-   Этот доступ можно использовать для клиентов: мобильных/десктопных приложений, утилит коммандной строки и т.д.

Безопасность
------------

-   Всегда используйте протокол HTTPS с действительным сертификатом
-   Если вы делаете мобильное приложение, позаботьтесь о безопасном хранении учетных данных пользователя на мобильном устройстве
-   После 3 неправильных подключений к пользовательскому api, пользователь может разблокировать свою учетную запись только с использованием формы входа
-   Двухуровневая аутентификация пока не доступна через API



Протокол
--------


Канборд использует протокол Json-RPC для взаимодействия с внешними программами.

JSON-RPC - протокол удаленного вызова процедур в формате JSON. По сути своей, тот же XML-RPC, но использующий формат JSON.

Мы используем [протокол версии 2](http://www.jsonrpc.org/specification). Вы можете вызывать API используя `POST`{.docutils .literal} HTTP запрос.

Канборд поддерживает пакетные запросы, поэтому вы можете делать многократные API вызовы в одном HTTP запросе. Это, в частности, удобно для мобильных клиентов с высокой сетевой задержкой.


Использование
-------------

-   [Аутентификация](api-authentication.markdown)
-   [Примеры](api-examples.markdown)
-   [Приложение](api-application-procedures.markdown)
-   [Проекты](api-project-procedures.markdown)
-   [Права доступа к проекту](api-project-permission-procedures.markdown)
-   [Доски](api-board-procedures.markdown)
-   [Колонки](api-column-procedures.markdown)
-   [Дорожки](api-swimlane-procedures.markdown)
-   [Категории](api-category-procedures.markdown)
-   [Автоматические дейсвия](api-action-procedures.markdown)
-   [Задачи](api-task-procedures.markdown)
-   [Подзадачи](api-subtask-procedures.markdown)
-   [Файлы](api-file-procedures.markdown)
-   [Ссылки](api-link-procedures.markdown)
-   [Комментарии](api-comment-procedures.markdown)
-   [Пользователи](api-user-procedures.markdown)
-   [Группы](api-group-procedures.markdown)
-   [Члены группы](api-group-member-procedures.markdown)
-   [Специфичные запросы пользователя](api-me-procedures.markdown)

 



[Русская документация Kanboard](http://kanboard.ru/doc/)

