API を使用してアプリをデプロイする

Webhook を使用して、Android アプリをデバイスにデプロイする方法をご紹介します。

Stripe はアプリのデプロイをレビューして承認を終えると、Webhook を介してメールでお客様に通知します。その後、以下の手順に従ってアプリをデプロイできます。

デプロイ中、アプリはデバイスに即時に送信され、ダウンロードされます。デバイスが再起動し、アプリがインストールされます。デバイスは 24 時間ごとに再起動され、更新がすべて自動的に適用されます。デバイスを手動で再起動すると、更新をすぐに確認して適用できます。

デバイスのデプロイグループを作成し、Location (場所) に関連付けることで、アプリをデバイスにデプロイします。

プライベートプレビュー

Apps on Devices API は現在、非公開ベータ版のみご利用いただけます。アクセス権の取得をご希望の場合、営業担当者までお問い合わいただければお客様の利用資格を評価いたします。

デバイスのデプロイグループを作成する

name と device_type を指定してデバイスのデプロイグループを作成します。

次のレスポンスは、デプロイ計画の作成に使用した tmddg_... 識別子を示しています。

{
  "id": "tmddg_EuEMSgeudJ0Zyw",
  "object": "terminal.device_deploy_group",
  "current_device_asset_versions": [],
  "device_type": "stripe_s700",
  "is_default": false,
  "livemode": false,
  "name": "my_toy_store_ddg"
}

デバイスのデプロイグループにリーダーを追加する

Location API を使用して、デバイスのデプロイグループにデバイスを追加します。Location (場所) の device_deploy_groups フィールドを設定して、device_type をデバイスのデプロイグループにマッピングできます。

Deploy API は、stripe_s700 デバイスタイプ (本番環境の Stripe S700 デバイスで使用) と stripe_s700_devkit デバイスタイプ (DevKit デバイスで使用) をサポートしています。

デバイスアセットのバージョンをデプロイグループにデプロイする際に、API は、compatible_device_types パラメーターがデプロイグループの device_type と一致していることを確認します。

デフォルトアプリを設定する

preferred_kiosk_app パラメーターを使用して、デバイスで起動するデフォルトのアプリを設定します。

アプリを更新する

device_asset_versions_to_install パラメーターを使用して、デバイスのデバイスアセットのバージョンを更新します。

アプリをデプロイした後、進捗状況を監視することができます。

アプリをアンインストールする

device_assets_to_uninstall パラメーターを使用して、デバイスからアプリをアンインストールします。

Stripe リーダーアプリを起動する

任意のキオスクアプリの代わりに Stripe リーダーアプリを起動するように、デバイスのデプロイグループを元に戻すことができます。

1 回のリクエストで、device_assets_to_uninstall パラメーターを使用して、ご使用のアプリをインストールした後に preferred_kiosk_app パラメーターを STRIPE_APP (大文字と小文字が区別される) に設定します。デバイスのデプロイグループにはサードパーティーアプリがないことを確認してください。

デバイスのデプロイグループからリーダーを削除する

デバイスのデプロイグループからリーダーを削除するには、Location (場所) の device_deploy_groups パラメーターを設定して、device_type を空の文字列にマッピングします。

デプロイグループのベストプラクティス

デバイスを複数のデプロイグループに分類して、ソフトウェアを個別に導入し、問題が発生した場合にエラーを隔離できます。デプロイグループの数は、ツール、リスクの許容度、特定のビジネスニーズに応じて、少なくなることも多くなることもあります。

以下のデプロイグループの設定をお勧めします。

アルファ: 内部の DevKit や内部の本番環境用デバイスに対応する場所が含まれます。
ベータ: 少数の実際のユーザーの場所が含まれます。これらの場所はランダムに選択したり、意味のある基準 (リスクの低い場所など) に基づいて選択したりできるほか、ユーザーがリスク許容度に基づいてベータデプロイグループにオプトインできるようにすることができます。
一般: Alpha または Beta のグループの場所を除く、実際のユーザーの残りすべての場所が含まれます。デフォルトのデプロイグループを使用した場合、残りの場所を手動で割り当てる必要はありません。

アプリをデプロイする準備ができたら、デプロイグループを最もリスクの低いものから最もリスクの高いものに昇格させます。


1	アルファ	最初に、アルファデプロイグループにデプロイして、ユーザーに対するリスクを最小限に抑えるためにアプリをテストします。この段階でバグや望ましくない動作が検出されても、実際のユーザーや現実の支払いに影響を与えることなく、影響は少数の内部デバイスに限定されます。
2	ベータ	次に、ベータデプロイグループにデプロイします。こうすると、すべてのユーザ―を潜在的な問題にさらすことなく、実際のユーザーにアプリを公開することができます。
3	一般的	最後に、問題に対処するか、ベータのデプロイグループに問題がないことを確認してから、一般のデプロイグループにデプロイします。

次のステップ

デプロイの監視