API & PlanRadar Connect

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 

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

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

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

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

PlanRadar Connect

PlanRadar Connect, работающий на базе Workato, позволяет вам интегрироваться более чем c 200 приложениями, не написав ни единой строки кода.

Перед использованием PlanRadar Connect наша команда по работе с клиентами рассмотрит ваши требования к интеграции, чтобы предоставить вам соответствующий доступ и поддержку. Чтобы запросить доступ, перейдите в Настройки > Учетная запись>> PlanRadar Connect>> и нажмите Запросить доступ. Затем с вами свяжется член нашей команды.