R&D Flow

API ключи

Общее

API ключ - уникальный jWTopen in new window идентификатор для программного доступа к проекту согласно разрешениям, которые определены в заданной ему при создании роли проекта.

Шаблон API ключа - частично сформированный API ключ без указания конкретного пользователя. Используется для быстрого создания API ключа по запросу пользователя.

API keys panel

Структура панели:

  • Раздел "API КЛЮЧИ"
    • Шаблоны API ключей - список панелей плиток шаблонов API ключей
    • - кнопка добавления нового шаблона API ключа
    • Запросы - список запросов на получение API ключей.
  • Раздел "ВЫДАННЫЕ КЛЮЧИ"

Плитка шаблона

API key panel

  1. Редактируемое название

  2. Редактируемое описание

  3. Редактируемое значение присвоенной роли

  4. Поля - кнопка добавления информационного поля

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

    Рекомендуются добавлять следующий информационные поля:

    • Идентификатор проекта - идентификатор текущего проекта
    • Идентификатор входного узла - узел, в который необходимо отправлять пакеты с данными
    • Идентификатор выходного узла - узел, из которого необходимо забирать пакеты с результатом.

  5. Редактируемое название информационного поля

  6. Редактируемое описание информационного поля

  7. Редактируемое значение информационного поля

  8. - кнопка вставки идентификатора проекта в качестве значения поля

  9. - кнопка вставки идентификатора выбранного узла в качестве значения поля

  10. - кнопка удаления поля

  11. - выпадающий список выбора роли

  12. - кнопка удаления шаблона

Плитка ключа

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

Плитка ключа может иметь вид:

  • Разрешения нового запроса ключа

    API request

  • Ожидание разрешения получения ключа

    API requested

  • Подтвержденый запрос на ключ

    API requested

Выданные ключи

Список выданных API ключей и статистика их использования доступна в разделе ВЫДАННЫЕ КЛЮЧИ.

API keys

Структура:

  • Панель инструментов
    • Период - отображаемый период
    • - кнопка обновления списка
  • Список выданных ключей
    • API ключ - название ключа
    • Пользователь - пользватель получивший ключ
    • Получен - дата выдачи
    • Запросы - количество запросов за выбранный период
    • Сумма - суммарная стоимость запросов за выбранный период
    • - кнопка удаления разрешения
  • Панель навигации