Главная Интеграции API-ключи

API-ключи

Обновлено Aug 26, 2026

Функционал API-ключей предназначен для безопасной интеграции внешних сервисов и скриптов с платформой PRM Online. Функционал позволяет гибко настраивать права доступа токенов, ограничить их срок действия и отслеживать детализированную историю вызовов API.

Документация Open API

Переход к управлению API-ключами

  1. Авторизуйтесь в кабинете администратора PRM Online.

  2. В левом боковом меню перейдите в раздел Настройки.

  3. В раскрывающемся списке выберите API.

  4. В правой части экрана откроется реестр API-ключей. Для добавления нового токена нажмите кнопку + Создать API-ключ.

Создание и настройка нового API-ключа

В открывшемся модальном окне API-ключ заполните необходимые параметры:

  1. Название токена (обязательное поле): Укажите понятное имя ключа, отражающее его назначение или интегрируемый сервис (например, МОП, Мессенджеры, Интеграция).

  2. Права доступа: Отметьте галочками категории действий, которые будут разрешены данному токену:

    • Чтение — только запрос данных по API для чтения.

    • Запись — создание новых сущностей и изменение существующих данных.

    • Удаление — возможность удаления данных из системы методами DELETE.

    • Админ — полный доступ ко всем эндпоинтам API без ограничений.

  3. Срок действия: Выберите период актуальности ключа из выпадающего списка:

    • 30 дней

    • 60 дней

    • 90 дней

    • Выбрать дату — ручной выбор любой даты завершения действия ключа через календарь.

  4. Для завершения нажмите кнопку Создать ключ.

Сохранение API-ключа

Важно! Сгенерированный API-ключ показывается только один раз при создании. После закрытия диалогового окна увидеть полный ключ будет невозможно.

Если полное значение ключа было утеряно, создайте новый API-ключ для восстановления доступа

  1. В окне подтверждения скопируйте сформированный токен, нажав на иконку Копировать справа от поля ключа.

  2. Сохраните токен в надежное место (например, в менеджер паролей).

  3. Закройте окно.

Использование API-ключа (на примере Postman)

Токен используется для авторизации запросов к публичному API PRM Online**:**

  1. Откройте клиент Postman (или аналогичную программу / библиотеку кода).

  2. Выберите или создайте нужный HTTP-запрос (например, GET https://api.prmonline.ru/v1/lead/status/list).

  3. Перейдите во вкладку Authorization.

  4. В поле Auth Type из выпадающего списка выберите тип Bearer Token.

  5. В появившемся поле Token вставьте скопированный ранее API-ключ.

  6. Нажмите Save для сохранения настроек запроса и выполните его (Send).

Управление и аудит API-ключей

В таблице API ключей отображается список всех созданных токенов с их текущим статусом (Активен, Отозван), сроком действия и назначенными правами.

Повторно увидеть полный ключ невозможно.

Действия с ключами:

  • Редактирование / Отозвать: Нажмите на контекстное меню (три точки ...) напротив нужного токена в списке:

    • Редактировать — изменение названия или прав доступа ключа.

    • Отозвать — мгновенное деактивирование ключа. Последующие запросы с этим токеном вернутся с ошибкой 403 (Forbidden, «Доступ запрещён»).

  • Просмотр истории событий (Аудит): Кликните по названию ключа в списке, чтобы открыть страницу подробной информации:

    • В блоке Последние события хранится лог вызовов за последние 30 дней.

    • Доступна фильтрация по Периоду, HTTP-методу (GET, POST, DELETE и др.) и Коду ответа (200 OK, 403 Forbidden и т.д.).

    • По клику на стрелочку в строке события открывается детальная информация по запросу: Endpoint, QueryParams и тело ответа ResponseBody.