Как создать ключ API App Store Connect
Shipcue читает статус проверки и выпускает версии через API App Store Connect от Apple. Для этого ему нужен ключ API от каждого аккаунта, за которым вы хотите следить. Вот как его создать, шаг за шагом.
Ключ Team или Individual?
В App Store Connect есть два вида ключей API. Shipcue работает с обоими.
- Ключ Team (рекомендуется). Его создаёт Admin команды. Он видит все приложения команды с ролью, которую вы выбрали для ключа. К нему прилагается Issuer ID.
- Ключ Individual. Создаётся в вашем собственном профиле. У него та же роль и доступ к приложениям, что и у вашего пользователя, так что он видит только те приложения, которые видите вы. Issuer ID у него нет. Вам нужно разрешение «Generate Individual API Keys», которое может выдать Admin команды.
Если вы работаете на клиентов, ключ Individual часто проще: не нужно просить Admin создать ключ, достаточно этого разрешения.
Какую роль должен иметь ключ?
Выберите минимальную роль, которой хватает для ваших задач:
- App Manager: лучший выбор для Shipcue. Эта роль может выпускать и отзывать версии, управлять поэтапным релизом и настраивать вебхуки, нужные для push, но не может управлять пользователями.
- Admin: тоже подходит, но может ещё добавлять и удалять пользователей. Не берите её для ключа, который хранится в телефоне.
- Developer: только просмотр. Shipcue показывает текущий статус при открытии или обновлении, но не может настроить push, выпустить или отозвать версию.
Создайте новый ключ только для Shipcue. Не используйте повторно ключ, от которого зависят ваш CI или другие инструменты, чтобы можно было отозвать один, не сломав другой.
Создание ключа Team
-
Откройте страницу ключей API
Войдите в App Store Connect в браузере как Admin. Откройте Users and Access, выберите вкладку Integrations, затем App Store Connect API в левом столбце. Если на странице есть кнопка Request Access, Account Holder должен один раз запросить доступ к API.
-
Сгенерируйте ключ
Убедитесь, что выбрано Team Keys, и нажмите Generate API Key (или кнопку +). Назовите его так, чтобы потом узнать, например «Shipcue». В поле Access выберите App Manager. Нажмите Generate.
-
Скачайте файл .p8
Нажмите Download API Key рядом с новым ключом. Apple позволяет скачать его только один раз и не хранит копию. Файл называется AuthKey_ и далее Key ID, например AuthKey_ABCD123456.p8. Сохраните его в надёжном месте, например в менеджере паролей.
-
Скопируйте Issuer ID
Issuer ID показан над списком ключей. Он выглядит так: 69a6de8f-3c2e-47e3-e053-5b8c7c11a4d1. Для ключа Team он понадобится в Shipcue.
Создание ключа Individual
-
Откройте свой профиль
В App Store Connect откройте свой профиль пользователя и прокрутите вниз до Individual API Key. Если кнопки Generate API Key нет, попросите Admin команды выдать разрешение «Generate Individual API Keys».
-
Сгенерируйте и скачайте
Нажмите Generate API Key, затем Download API Key. Как и ключи Team, файл .p8 можно скачать только один раз. У ключа Individual нет Issuer ID.
Добавьте ключ в Shipcue
-
Запустите Add Account
В Shipcue нажмите Add Account. Выберите файл .p8 в приложении «Файлы», отправьте его по AirDrop с Mac и выберите Shipcue или вставьте текст ключа.
-
Проверьте данные
Если у файла осталось имя AuthKey_, Shipcue сам подставит Key ID. Вставьте Issuer ID для ключа Team или оставьте поле пустым для ключа Individual. Дайте аккаунту понятное вам название, например «Client: Acme».
-
Пусть Shipcue проверит его у Apple
Shipcue спрашивает App Store Connect, какие приложения видит ключ. Новому ключу может понадобиться минута или две, чтобы заработать; Shipcue продолжает попытки.
-
Выберите приложения
Выберите приложения, за которыми нужно следить. С Shipcue Pro приложение добавляет по одному вебхуку на каждое приложение у Apple, чтобы изменения статуса приходили вам как push. Apple разрешает 10 вебхуков на приложение, Shipcue использует 1.
Что полезно знать
- По умолчанию ключ сохраняется в вашем iCloud Keychain со сквозным шифрованием Apple, чтобы им могли пользоваться и iPhone, и iPad. Вместо этого можно хранить ключ только на одном устройстве. В режиме Private он никогда не попадает на наш сервер.
- Каждому добавленному аккаунту App Store Connect нужен свой ключ.
- Чтобы остановить ключ везде, отзовите его в App Store Connect: Users and Access › Integrations › App Store Connect API, выберите ключ, Revoke. Это же первый шаг, если вы потеряли устройство (см. Потеряли устройство?).
- Никому не отправляйте файл .p8 или его содержимое, включая нас.
Вопросы
Можно ли скачать файл .p8 ещё раз?
Нет. Apple даёт скачать его только один раз. Если файл потерян, отзовите этот ключ в App Store Connect и создайте новый. В Shipcue используйте Replace Key в аккаунте, чтобы сохранились его приложения и настройки.
Где найти Issuer ID?
В App Store Connect: Users and Access › Integrations › App Store Connect API, над списком ключей Team. У ключей Individual его нет.
Можно ли использовать ключ с ролью Developer?
Да, но только для просмотра статуса. Ключи Developer не могут создавать вебхуки, поэтому push для таких приложений не будет, и выпускать или отзывать версии они тоже не могут. Для полного набора возможностей используйте App Manager.
Нужен ли Shipcue пароль от моего Apple Account?
Нет. Shipcue использует только ключ API. Входа через ваш Apple Account и кода двухфакторной аутентификации нет.
См. также
Следите за всеми аккаунтами в одном месте
Shipcue присылает push, когда меняется статус App Review, для каждого добавленного аккаунта App Store Connect. 14 дней бесплатно.
Как работает Shipcue