База знаний — Интеграция ПО через API

В этой статье вы узнаете о следующем:

  1. Интерактивная документация по API
  2. Управление своими персональными маркерами доступа
  3. Управление уведомлениями о совершенных действиях (вебхуками) в своей учетной записи
  4. Выдача разрешения пользователя на доступ к функционалу API

 

Программная интеграция через API

PlanRadar предоставляет веб API (интерфейс программирования приложений) и веб-хуки (уведомления о совершенных действиях в Интернет-систем). Это позволяет вам интегрировать стороннее программное обеспечение или специально разработанное программное обеспечение в вашу учетную запись PlanRadar.

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

 

Интерактивная документация по API

Прежде чем продолжить, убедитесь, что у вас есть разрешения на доступ к функциям API. Вы можете получить доступ к документации API через Настройки> Документация API:

 

Вы можете напрямую попробовать все эндпоинты (конечные точки). Для ряда эндпоинтов вам будет необходимо указать ID проекта или ID задачи, которые вы обычно находите и копируете из URL, когда просматриваете конкретную задачу или проект.

Вы также получите возможность копировать и вставлять компактный URI (Compact URIs) и потестить API в командной оболочке. Однако вам потребуется доступ маркер доступа — читайте об этом в следующем разделе.

 

Управление своими персональными маркёрами доступа

Использование персональных маркеров доступа позволяет внешнему ПО аутентифицироваться с нашими серверами во время использования API.

Прежде чем продолжить, убедитесь, что у вас есть разрешения к доступам к API функциям. Вы можете создать и управлять персональными маркерами доступа, зайдя в Настройки> Профиль> Персональные маркеры доступа

 

Эти маркеры пользовательского уровня. Вы не должны делиться ими ни с кем другим и должны обращаться с ними осторожно. Любой, у кого есть маркер доступа, потенциально может получить доступ к вашей учетной записи и действовать от вашего имени.

 

По умолчанию максимальный лимит – 30 запросов в минуту. По запросу этот лимит может быть увеличен, тогда, пожалуйста, свяжитесь с нами через почту [email protected].
 

Управление вебхуками в вашей учетной записи

Вебхуки позволяют внешнему ПО реагировать на события, которые происходят в PlanRadar, например, «задача создана», «задача обновлена», «фото прикреплено» и т.д. Чтобы создать и управлять Вебхуками, зайдите в Настройки > Учетная запись > Вебхуки.

Эти настройки доступны только владельцам учетной записи.

 

Нажмите «Добавить новый вебхук». Здесь вы сможете выбрать, о каких именно событиях ваше внешнее ПО должно получать уведомления.

 

Аутентификация:
Здесь вы настраиваете способ, как мы можем аутентифицироваться на вашем сервере. В настоящее время мы поддерживаем “ Базовую Аутентификацию HTTP ” с использованием имени и пароля.

 

Заголовки:
Если вы хотите предоставить дополнительные поля заголовка для своей службы, вы можете их здесь настроить. Для паролей или секретной информации мы предоставляем в пользовательском интерфейсе возможность скрыть значение. Если вы выберете скрыть его, тогда вы не сможете вызвать его в пользовательском интерфейсе после сохранения вашего вебхука по причине безопасности.

 

Выдача разрешения пользователя к доступу функционала API

Доступ к страницам Интерактивная документация по API и Персональные маркеры возможен только при наличии соответствующих разрешений пользователя. Владельцы учетных записей получат доступ к документации по API автоматически.

Чтобы предоставить другим внутренним пользователям соответствующие разрешения, перейдите в раздел Управление Пользователями > Пользователи. Там редактируйте или создавайте нового внутреннего пользователя и потом отметьте разрешение «Доступ к API».

 

Аннулирование маркеров доступа для других пользователей

У вас есть возможность удалять разрешения на маркеры доступа, созданные другими внутренними пользователями. Чтобы удалить маркер доступа, вам нужно иметь разрешение на управление пользователями.

Чтобы удалить созданный не вами маркер доступа, зайдите при помощи навигационной панели в раздел Управление пользователями> Пользователи. Там вы выбираете из списка внутренних пользователей , чей маркер вы хотите удалить из системы. Справа вы увидите все маркеры доступа, которые были созданы другими пользователями – выбирайте тот, что вам нужно, и удаляйте.

 

Обратите внимание: маркеры доступа, созданные владельцем учетной записи не могут быть удалены другими пользователями. Только сам владелец учетной записи может удалить свои маркеры доступа: Настройки > Профиль > Персональные маркеры доступа.

Вернуться к Оглавлению.