これは何
WWDC 2018 のセッション Automating App Store Connect のメモです。
セッション概要
The new App Store Connect API provides a familiar and highly readable REST API designed to facilitate the automation of many tasks you would typically perform through the Apple Developer website and the App Store Connect browser interfaces. Learn how this API allows you to manage your apps and testers for TestFlight, create code signing resources, download reports, and even manage your organization. See how this API leverages JWT authentication and a JSON payload for all transactions to make this new service easy to integrate with your existing automated workflows.
新しいApp Store Connect APIは、Apple Developer WebサイトやApp Store Connectのブラウザインターフェイスを使って、通常実行する多くのタスクの自動化を容易にするように設計された使い慣れた読みやすいREST APIを提供します。 このAPIを使用してTestFlightのアプリケーションとテスターを管理したり、コード署名リソースを作成したり、レポートをダウンロードしたり、組織の情報を管理したりすることができます。この新しいサービスを既存の自動ワークフローと容易に統合するために、JWT認証とすべてのトランザクションのJSONペイロードをどのように利用するか御覧ください。
Getting data
APIのURLは
api.appstoreconnect.apple.com
のようなドメインになる。
様々な情報が取得できる。
例えば
GET api.appstoreconnect.apple.com/v1/users
はユーザー情報を取得するAPI。次のようなレスポンスが返ってくる。
Changing data
HTTPメソッドは次のものを利用する。
例えばユーザーにインビテーションを送る場合は POST
。
ユーザーの属性を更新する場合は PATCH
。
ユーザーを削除する場合は DELETE
。
Relationships
TestFlight にはテスターをグルーピングできる機能があるが、それらの管理(テストメンバーの取得や追加)も可能。
include=betaTesters
を付加することで各メンバーの詳細な情報も一度に取得可能。
Errors
エラーの場合は次のようなJSONが返される。
Access and authentication
APIアクセスにはトークンが必要。トークンを使用せずにAPIにアクセスすると NOT_AUTHORIZED
エラーになる。
トークンは Public Key, Private Key から構成される。
前者はアップルのサーバーに保存されるが、後者はApp Store Connectから一度だけダウンロードできる(デモでは .p8 ファイルで保存されていた)。
トークンを構成するキーなどはApp Store Connectから確認できる。
Private Keyはアップルでは管理しないので、ちゃんと自分で管理してね。間違っても拡散しないように。
JWT(JSON Web Token) を構成するフィールド。
これらの情報をもとにトークンを生成する。
APIリクエストの際、トークンを Authorization:
に含めることで情報が取得できるようになる。
Best practices
- Private Key をしっかり保管しましょう
- トークンは有効期限内であれば再利用しましょう
- 詳しくはドキュメントを読んでね
リリース時期
App Store Connect APIはこの夏、利用可能になるとのことです。
楽しみですね!