Настройка интеграции с App Store

Чтобы подключить iOS-приложение к Adapty, введите учётные данные App Store в App settings > iOS SDK. После этого Adapty:

  • Проверяет покупки.
  • Получает события подписок.
  • Синхронизирует ваши продукты с App Store Connect.

Если покупки или события подписки перестали поступать в Adapty, проверьте каждый из реквизитов.

Прежде чем начать:

  • Вам нужен доступ к целевому приложению в App Store Connect. Если приложения там ещё нет, настройте App Store Connect. Если у вас нет доступа к платформе, запросите его.
  • Вашей команде нужен доступ к API App Store Connect — он необходим для генерации нужного ключа доступа. Если у вашей команды его ещё нет, попросите Account Holder запросить его. Apple проверяет каждый запрос.
  • Откройте две вкладки браузера: ваше приложение в App Store Connect в одной и App settings > iOS SDK в Adapty в другой. В ходе этого гайда вы будете копировать значения между вкладками.

Обзор

Каждый из учётных данных в этом гайде обязателен. Adapty использует каждый из них для определённой части обмена данными с App Store. Чтобы завершить настройку, выполните следующие семь шагов:

  1. Введите Bundle ID и Apple App ID
  2. Введите app-specific shared secret
  3. Включите уведомления сервера App Store с URL-адресом из Adapty
  4. Добавьте ключ In-App Purchase
  5. Добавьте ключ App Store Connect API
  6. Установите SDK Adapty и совершите тестовую покупку в песочнице
  7. Проверьте все данные

Введите Bundle ID и Apple App ID

Два значения идентифицируют ваше приложение в App Store Connect: Bundle ID и Apple ID, который в Adapty называется Apple App ID. Bundle ID нужен Adapty для обработки покупок. Apple ID позволяет Adapty:

  • Находить ваши продукты в App Store Connect и создавать там новые.
  • Отображать статус App Store и цены ваших продуктов.
  • Отправлять сообщения в реальном времени для Retention Messaging.
  • Идентифицировать ваше приложение для интеграций атрибуции, например AppsFlyer.

Apple присваивает Apple ID при добавлении приложения в App Store Connect, поэтому введите его даже до того, как ваше приложение появится в App Store.

  1. Open App Store Connect. Select your app and proceed to General > App Information section.

  2. Copy the Bundle ID in the General Information sub-section.

    Copy only the identifier — reverse-DNS format with no spaces, for example, com.company.app. App Store Connect shows the app name next to it in other views, like the apps list; pasting that instead of the identifier makes the connection between Adapty and the App Store fail to validate.

asc-app-information-bundle-id.webp
  1. Open the App settings > iOS SDK tab from the Adapty top menu and paste the copied value to the Bundle ID field.
app-settings-bundle-id.webp
  1. Get back to the App information page in App Store Connect and copy Apple ID from there.
asc-app-information-apple-id.webp
  1. On the App settings > iOS SDK page in the Adapty dashboard, paste the ID to the Apple App ID field.
app-settings-apple-app-id.webp

Введите app-specific shared secret

Adapty нужен app-specific shared secret для валидации чеков покупок и создания продуктов в App Store Connect.

  1. В App Store Connect откройте страницу App Information вашего приложения. В разделе App-Specific Shared Secret нажмите Manage.

    Раздел App-Specific Shared Secret на странице App Information в App Store Connect
  2. Скопируйте секрет. Если у приложения ещё нет секрета, сначала нажмите Generate. Для генерации секрета необходима роль Account Holder или Admin в App Store Connect. Если у вас нет ни одной из этих ролей, попросите того, у кого она есть, сгенерировать секрет и передать его вам.

    Если вы не получали приложение через передачу приложения, не нажимайте Regenerate: текущий секрет перестанет работать везде, где он используется.

    App-Specific Shared Secret window with the secret
  3. В Adapty вставьте секрет в поле App Store Connect shared secret.

    App Store Connect shared secret field in Adapty
  4. Нажмите Save.

Включите серверные уведомления App Store с URL от Adapty

Apple отправляет серверные уведомления в Adapty о продлениях, возвратах средств и других событиях подписки в режиме реального времени. Adapty записывает эти события даже тогда, когда приложение не сообщает ни о каких транзакциях.

Если Apple уже отправляет эти уведомления на ваш сервер, настройте переадресацию на него до того, как замените URL в App Store Connect. В Adapty укажите URL этого сервера в поле URL for forwarding raw Apple events и нажмите Save. После этого Adapty будет пересылать полученные от Apple уведомления на ваш сервер.

Если ваш бэкенд должен сохранить свой URL в App Store Connect, передавайте уведомления в Adapty со стороны бэкенда.

  1. В Adapty откройте приложение, которое вы подключаете: у каждого приложения Adapty есть собственный URL для уведомлений. Перейдите в App settings > iOS SDK. В разделе App Store server notifications скопируйте URL из поля URL for App Store server notifications.

    URL for App Store server notifications in the App Store server notifications section in Adapty
  2. В App Store Connect откройте страницу App Information вашего приложения.

  3. В разделе App Store Server Notifications найдите Production Server URL. Если URL уже указан, нажмите Edit. В противном случае нажмите Set Up URL.

    App Store Server Notifications section on the App Information page in App Store Connect
  4. Вставьте URL из Adapty и нажмите Save.

    Production Server URL dialog in App Store Connect with the URL from Adapty
  5. Чтобы уведомления из тестовой среды (песочницы) тоже доходили до Adapty, повторите шаги 3 и 4 для Sandbox Server URL.

Добавьте ключ In-App Purchase

Adapty использует ключ In-App Purchase для валидации покупок и подписи promotional offer. Если у вас ещё нет файла ключа, сначала создайте ключ в App Store Connect. Чтобы добавить ключ в Adapty:

  1. Чтобы найти Issuer ID и Key ID вашего ключа, в App Store Connect перейдите в Users and Access > Integrations > In-App Purchase. Если кто-то другой сгенерировал ключ и передал вам его Issuer ID, Key ID и файл, пропустите этот шаг.

    Issuer ID и Key ID ключа In-App Purchase в App Store Connect
  2. В Adapty перейдите в App settings > iOS SDK. В разделе In-app purchase API (StoreKit 2) заполните поля:

    • Issuer ID: скопируйте со страницы In-App Purchase в App Store Connect.
    • Key ID: скопируйте из списка Active на странице In-App Purchase, рядом с загруженным ключом.
    • Private key (.p8 file): загрузите скачанный файл.
    Поля Issuer ID, Key ID и Private key (.p8 file) в разделе In-app purchase API (StoreKit 2) в Adapty
  3. Adapty подписывает promotional offers с помощью ключа In-App Purchase. В разделе App Store promotional offers укажите ключ ещё раз:

    • Subscription key ID: Key ID из шага 2.
    • Subscription key (.p8 file): файл из шага 2.
    Поля Subscription key ID и Subscription key (.p8 file) в разделе App Store promotional offers

    Если указать другой ключ, ошибки не будет, но пользователи не смогут получать promotional offers.

  4. Нажмите Save. Перед сохранением страницы Adapty проверяет ключ в разделе In-app purchase API (StoreKit 2) через Apple. Если Apple отклоняет ключ, страница показывает сообщение «The provided field values are incorrect»: проверьте введённые значения.

Добавьте ключ API App Store Connect

Adapty использует ключ API App Store Connect для создания продуктов в App Store Connect и синхронизации их статуса и цен. Это отдельный ключ, не связанный с ключом In-App Purchase, хотя оба используют одни и те же названия полей: Issuer ID и Key ID.

Adapty требует командный ключ с доступом Admin. Если у вас его ещё нет, сначала создайте его в App Store Connect. Чтобы подключить ключ в Adapty:

  1. Чтобы найти Issuer ID и Key ID вашего командного ключа, в App Store Connect перейдите в Users and Access > Integrations > App Store Connect API и откройте вкладку Team Keys. Если кто-то другой сгенерировал ключ и прислал вам его Issuer ID, Key ID и файл — пропустите этот шаг.

    Issuer ID и Key ID командного ключа на вкладке Team Keys в App Store Connect
  2. В Adapty перейдите в App settings > iOS SDK. В разделе App Store Connect API key нажмите Connect API Key.

    Раздел App Store Connect API key в Adapty с кнопкой Connect API Key
  3. Заполните поля:

    • Issuer ID: скопируйте со вкладки Team Keys в App Store Connect.
    • Key ID: скопируйте из списка Active на вкладке Team Keys, рядом с загруженным ключом.
    • Private key (.p8 file): загрузите файл, скачанный для командного ключа.
    Поля Issuer ID, Key ID и Private key (.p8 file) в окне подключения App Store Connect API key
  4. Подключённый ключ можно заменить позже, но удалить нельзя. Убедитесь, что ключ принадлежит той команде App Store Connect, которой принадлежит это приложение, и нажмите Connect. После этого App Store Product ID для каждого продукта можно выбирать из списка App Store Connect, а не вводить вручную.

    Adapty не проверяет ключ через Apple в момент подключения. Неверный ключ не даёт ошибки, связанной с ключом: продукты не показывают статус в App Store, а выпадающий список App Store Product ID остаётся пустым. Чтобы исправить неверный ключ, замените его.

Проверьте, что каждый ключ работает

Чтобы убедиться, что Adapty корректно валидирует покупки, установите SDK в своё приложение и совершите тестовую покупку в песочнице.

При тестовой покупке в песочнице используются не все ключи. Проверьте каждый из них после покупки, а также каждый раз, когда покупки или события подписки перестают поступать в Adapty:

  • Bundle ID, Apple App ID и App Store Connect shared secret: сравните эти три значения с Bundle ID, Apple ID и секретом в разделе App-Specific Shared Secret на странице App Information в App Store Connect.
  • App Store server notifications: статус в этом разделе отображается как Active, когда Adapty получает уведомление о покупке или продлении подписки. Если отображается другой статус, проверьте URL сервера.
  • In-app purchase API (StoreKit 2): Adapty проверяет ключ через Apple при сохранении. Если покупки в приложении перестали открывать доступ, ключ мог перестать работать — замените его.
  • App Store promotional offers: убедитесь, что Subscription key ID совпадает с Key ID в разделе In-app purchase API (StoreKit 2). Если они отличаются, введите одинаковый ключ в оба раздела.
  • App Store Connect API key: для каждого продукта App Store на странице Products в столбце App Store status отображается статус. Если для продукта стоит прочерк или статус Not Connected, проверьте ключ и Apple App ID.

Сразу после настройки Analytics может показывать больше триалов и покупок, чем установок, и больше, чем отображается в Event Feed. Разница — это транзакции без профилей: покупки пользователей, которые ещё не открывали версию приложения с Adapty SDK.

Другие расхождения между отчётами Adapty и стора объясняются тем, как каждый из них считает покупки, а не настройками учётных данных.

Следующие шаги

Чтобы подготовить приложение к выпуску, пройдите чеклист перед релизом.

Если ваше приложение также опубликовано в Google Play, подключите этот стор.