Руководство по App Store Connect API Key: Создание, Управление и Отзыв
API-ключ в App Store Connect — это важный инструмент для безопасного управления приложениями и оптимизации ASO. Он позволяет автоматизировать доступ к метаданным, аналитике и другим данным вашего приложения.
В App Store Connect доступны два типа API-ключей:
Ключи API команды:
- Предназначены для участников команды, которым нужен доступ к нескольким приложениям в организации.
- Эти ключи предоставляют более широкие разрешения на основе назначенных ролей в App Store Connect.
- Идеально подходят для управления приложениями на уровне команды, включая обновление метаданных, аналитику и финансовые отчеты.
Индивидуальные API-ключи:
- Предназначены для использования с ограниченным доступом к определенным приложениям.
- Разрешения можно настроить так, чтобы предоставлять доступ только к определенным функциям, таким как редактирование метаданных, управление приложениями или финансовые данные.
- Полезны в ситуациях, когда необходимо более гранулированное управление доступом, обеспечивая взаимодействие пользователей только с определенными разделами App Store Connect.
- Разрешения соответствуют уровню привилегий учетной записи, к которой привязан ключ.
Ниже приведены основные советы по эффективному использованию API-ключа:
- Срок действия: API-ключи являются постоянными и не истекают.
- Изменение API-ключа: После создания нельзя изменить ключ для расширения доступа к дополнительным сервисам.
- Отзыв: В App Store Connect можно отозвать ключ в любой момент, но после отзыва он не подлежит восстановлению.
- Ограничения: В одном аккаунте может быть не более 50 активных ключей одновременно.
Командные (Team) API-ключи
Командные API-ключи предназначены для организаций и команд, которые управляют несколькими приложениями в App Store Connect. Эти ключи предоставляют более широкий доступ и обычно используются в совместных рабочих процессах, где нескольким участникам команды требуется взаимодействовать с различными функциями App Store.
Основные возможности:
- Доступ на уровне организации: позволяет участникам команды управлять несколькими приложениями в рамках одного аккаунта разработчика.
- Ролевые разрешения: уровни доступа регулируются в зависимости от назначенной роли в App Store Connect (например, Администратор, Разработчик, Финансы, Маркетинг).
- Расширенный функционал: поддерживает задачи, такие как обновление метаданных приложений, сбор аналитики, изменение цен и финансовая отчетность.
- Используется для автоматизации: часто интегрируется с CI/CD-пайплайнами, ASO-инструментами и сторонними сервисами для оптимизации управления приложениями.
Оптимальные сценарии использования:
- Крупные команды, где нескольким участникам требуется API-доступ для совместного управления приложениями.
- Агентства по разработке, работающие с несколькими клиентскими приложениями в одном аккаунте App Store Connect.
- Крупные компании, которым необходимы автоматизированные процессы для обновления метаданных, изменения цен или сбора аналитики.
- Индивидуальные разработчики, управляющие несколькими приложениями в одном аккаунте.
Выпуск нового командного (Team) API-ключа в App Store Connect
На странице App Store Connect создайте новый .p8 API-ключ (App Store Connect API) в разделе Пользователи и доступ → Интеграция → API App Store Connect:
Мы рекомендуем создавать уникальный ключ для каждой группы приложений.
У только что созданного ключа должен быть уровень доступа не ниже Менеджер приложений:
Основные сведения о командном (Team) API-ключе
Скачайте сгенерированный ключ — файл с расширением .p8.
Обратите внимание на Issuer ID (указан выше таблицы “Активно”).
Issuer ID — это уникальный идентификатор, предоставляемый Apple для каждой учетной записи App Store Connect.
Он используется для аутентификации запросов, выполненных с помощью API-ключа, и связывает ключ с конкретной учетной записью разработчика Apple.
Этот идентификатор, вместе с Key ID и файлом закрытого ключа (.p8), требуется для безопасного доступа и управления данными приложения в App Store Connect.
При настройке интеграций на основе API (например, в ASO.dev) вам потребуется ввести Issuer ID, Key ID и закрытый ключ для API-ключа для авторизации действий, таких как редактирование метаданных или просмотр отзывов.
Отзыв командного (Team) API-ключа в App Store Connect
В разделе App Store Connect отзовите ключ App Store Connect API в Пользователи и доступ → Интеграция → API App Store Connect → Ключи команды:
Отзыв ключа немедленно отключает доступ, обеспечивая повышенную безопасность в случае компрометации или если ключ больше не нужен.
Отозванные API-ключи удаляются навсегда и не могут быть восстановлены.
Чтобы вернуть доступ, необходимо создать новый API-ключ.
Персональные (Individual) API-ключи
Индивидуальные API-ключи предназначены для личного использования и обеспечивают ограниченный доступ к конкретным приложениям и функциям в App Store Connect.
Эти ключи позволяют более детально настраивать права доступа, давая разработчикам или участникам команды возможность работать только с определёнными разделами приложения без риска раскрытия данных всего аккаунта.
Права доступа соответствуют уровню привилегий учетной записи, к которой привязан ключ.
Основные возможности:
- Доступ только к определённым приложениям: разрешает работу с выбранными приложениями, а не со всеми в аккаунте.
- Гибкое разграничение прав: можно настроить доступ к отдельным функциям, например редактированию метаданных, обновлению цен или аналитике приложения, при этом ограничив доступ к финансовым данным.
- Повышенная безопасность: минимизирует ненужное раскрытие конфиденциальной информации, предоставляя доступ только к необходимым функциям.
- Идеально для подрядчиков и узкоспециализированных ролей: позволяет временным сотрудникам, фрилансерам или внешним специалистам (например, ASO-менеджерам) выполнять определённые задачи без полного административного доступа.
Сценарии использования:
- Инди-разработчики, использующие API-автоматизацию для управления своими приложениями.
- Компании, обеспечивающие строгий контроль доступа и ограничивающие работу с чувствительными данными, такими как финансовые отчёты.
- Внешние подрядчики или ASO-специалисты, которым нужен доступ только к редактированию метаданных без полномочий на полное управление приложением.
Выпуск нового индивидуального (Team) API-ключа в App Store Connect
Настройка пользователя в App Store Connect и API-ключа
Перейдите в App Store Connect.
В разделе Пользователи и доступ → Люди выберите существующего или создайте нового пользователя.
Назначьте необходимый уровень доступа и выберите соответствующие приложения.
Обычно подходят роли Менеджер приложений или Поддержка пользователей.
Помните, что у пользователя может быть только один API-ключ. Если вам нужно создать новый ключ, сначала аннулируйте (revoke) существующий.
Отзыв индивидуального (Individual) API-ключа в App Store Connect
В разделе App Store Connect отзовите ключ App Store Connect API в Пользователи и доступ → Интеграция → API App Store Connect → Индивидуальные ключи:
Аннулирование ключа немедленно отключает доступ, обеспечивая повышенную безопасность в случае компрометации или если ключ больше не нужен.
Аннулированные API-ключи удаляются навсегда и не могут быть восстановлены.
Чтобы вернуть доступ, необходимо создать новый API-ключ.