Один API для разных клиентов

Собственный веб-интерфейс, драйвер GrigDesk и будущие клиенты используют единый API трекера. Поставка только с API предусмотрена отдельно.

Контракт ещё разрабатывается. Опубликованная спецификация OpenAPI и проверенные примеры запросов появятся вместе с выпуском.

Доступ по токену

Персональный API-токен имеет срок действия, область чтения или записи и набор доступных проектов. Он действует в пределах актуальных прав своего владельца и не даёт управления пользователями.

Адрес установки должен использовать HTTPS. Блокировка пользователя отзывает его сессии и токены.

Изменения и повторная доставка

API проектируется с идентификатором операции и проверкой версии изменяемого объекта. Повтор одного запроса не должен повторно создавать задачу, а конфликт версии не должен незаметно затирать чужую правку.

После восстановления установки из копии клиенту потребуется сверить старые действия с новой историей сервера.

События и файлы

В план входят поток событий для обновления интерфейса, поиск, история, загрузка файлов частями и продолжение прерванной загрузки. Проверки прав распространяются и на эти операции.

Что можно подготовить сейчас

Определите проекты, необходимые права клиента и сценарии обработки конфликтов. Не стройте интеграцию на адресах или схемах из учебной доски: она не использует сетевой API.

Связанные разделы: плохая сеть, драйвер GrigDesk, статус проекта.