Перейти к основному содержимому

Сервис API-ключей

Этот сервис позволяет выпускать API-ключи и управлять ими через веб-интерфейс Менеджера Платформы. Конечные пользователи сервисов программного комплекса 2ГИС затем используют предоставленные ключи для получения доступа к установленным сервисам.

Администратор выпускает один или несколько API-ключей для партнёра — именованной сущности, которая хранит в себе сгруппированный набор API-ключей.

Сервисы программного комплекса 2ГИС, для работы с которыми конечному пользователю необходимы API-ключи:

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

Архитектура​

Архитектура сервиса API-ключей

Сервис ключей состоит из бэкенд-сервиса и вспомогательных компонентов. Бэкенд-сервис предоставляет RESTful API: через него другие сервисы проверяют API-ключи. Администратор управляет ключами в Менеджере Платформы. Пользователи проходят аутентификацию через поставщика OpenID Connect (OIDC), например Platform ID.

Каждый сервис программного комплекса 2ГИС перед выполнением запроса от конечного пользователя отправляет метаданные этого запроса в сервис ключей (включая API-ключ, с которым пришёл запрос). Сервис ключей читает события, связанные с API-ключами, из хранилища Apache Kafka (на схеме — Broker). Дополнительно ведутся счетчики использования ключей, соответствующие данные хранятся в Redis (на схеме — Redis-like DBMS).

Сервис Tasker получает данные о событиях от бэкенда сервиса ключей и выполняет требуемые административные действия над ключами в зависимости от наступивших событий: например, блокирует или разблокирует конкретный API-ключ. Это позволяет сервису ключей контролировать использование API-ключей и управлять доступом, основываясь на квотах: например, если пользователь выполнит более 100 запросов за минуту к сервисам поиска, можно заблокировать доступ к этим сервисам для данного API-ключа до начала следующей минуты.

Детали архитектуры программного комплекса 2ГИС приведены в документе Архитектура.

Зависимости​

Общая инфраструктура:

  • Хранилище Apache Kafka для сбора данных о статистике использования API-ключей. Установка этого хранилища необязательна, если вы не планируете использовать сервис сбора статистики.
  • Хранилище Redis для ведения статистики использования ключей.
  • Хранилище PostgreSQL для хранения ключей и связанных с ними данных.
Можно использовать аналоги из реестра Минцифры

Доступные аналоги указанного программного обеспечения, включённые в реестр Минцифры, см. в разделе Системные требования.

Что дальше?​