Deploy your app with the API

Learn how to deploy your Android app to your devices through a webhook.

After Stripe reviews and approves your app for deployment, we notify you by email through a webhook. You can then follow the instructions below to deploy your app.

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

Terminal デバイス用の新しいアプリや更新されたアプリを、ダッシュボードでデプロイできます。

デプロイグループを追加または編集する

デプロイグループを追加または編集する前に、Terminal の場所を作成し、その場所にリーダーを追加する必要があります。その後、場所をデプロイグループに割り当てると、その場所のすべてのリーダーがそのデプロイグループから更新を受信するようになります。

デプロイグループを作成した後は、それを選択していつでも編集できます。

デプロイグループを追加する

Terminal アプリタブで、デプロイグループを管理をクリックします。
デプロイグループを追加をクリックします。
デプロイグループを追加ドロワーで次の手順を実行します。
- グループ名を入力します。
- Terminal のデバイスタイプを選択します。
- 必要に応じて、デフォルトのデプロイグループチェックボックスを選択して、デフォルトのデプロイグループを作成します。デフォルトのデプロイグループには、別のデプロイグループに明示的に割り当てられていないすべての場所が自動的に含まれます。デバイスタイプごとにデフォルトのデプロイグループを 1 つ作成できます。
- 完了をクリックします。

デスティネーション支払いでデプロイグループを管理する

Terminal アプリタブで、デプロイグループを管理をクリックします。
リストからデプロイグループを選択します。
場所を追加をクリックします。
追加する場所を選択します。
完了をクリックします。

ダイレクト支払いでデプロイグループを管理する

Terminal アプリタブで、デプロイグループを管理をクリックします。
リストからデプロイグループを選択します。
場所を追加をクリックします。
アカウントのドロップダウンで、場所を追加する元となるアカウントを選択します。場所を追加する前に、アカウントを選択する必要があります。
追加する場所を選択します。
完了をクリックします。

アプリのバージョンをデプロイする

Stripe のレビュー担当者が承認した後でアプリをデプロイできます。

Terminal アプリタブで、デプロイするアプリを選択します。
アプリの詳細ページで、バージョンをデプロイをクリックします。
承認済みのアプリのバージョンを選択し、次へをクリックします。以前のバージョンのアプリをデプロイすることはできません。アプリのバージョンは、現在デプロイされているアプリよりも新しいバージョンである必要があります。
デプロイグループを選択し、次へをクリックします。
利用するキオスクアプリを選択し、次へをクリックします。これは、Stripe リーダーがオンになったときに起動するデフォルトのアプリです。デプロイするアプリが 1 つしかない場合は、代わりにそのアプリを選択します。
デプロイの詳細を確認し、デプロイをクリックします。アプリはすぐにデプロイされます。

複数の Stripe アカウントがあり、複数のアカウントに同じアプリをデプロイする場合は、この機能を使用します。複数のアカウントで 1 つのアプリを共有することで、パッケージ名の一意性やアプリのレビューの重複による制約を回避できます。

アプリを作成して管理するアカウントを 1 つ指定します。新しいアプリバージョンをアップロードできるのは、アプリを所有するアカウントのみですが、他のアカウントはアプリ ID を検索してアプリを表示してデプロイできます。

Terminal アプリタブで、オーバーフローメニュー ()をクリックします。
アプリを検索をクリックします。
アプリ ID を入力し、アプリの詳細を表示をクリックします。
バージョンをデプロイをクリックし、デプロイの詳細を入力します。

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

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

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

The following response shows a tmddg_... identifier that you used to create the deployment plan.

{
  "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	一般的	最後に、問題に対処するか、ベータのデプロイグループに問題がないことを確認してから、一般のデプロイグループにデプロイします。

次のステップ

デプロイの監視