記事のサマリー(TL;DR)
- shopify.app.tomlに新しい[network_access]セクションが追加され、アプリの外部ホストやサーバーを宣言できるようになりました。
- allowed_navigation_hosts(最大20件)とallowed_sources(最大20件のHTTPSオリジン)という2つのプロパティが用意されています。
- ストアフロント、チェックアウト、Shopify管理画面から外部サーバーにリンクまたは通信を行うアプリが対象で、設定後はshopify app deployの実行とリリースが必要です。
対象と推奨される対応
ストアフロント、チェックアウト、またはShopify管理画面から外部サーバーにリンクしたり通信したりするコードを持つアプリが対象です。Shopifyはすべてのアプリに対し、以下の対応を強く推奨しています。
- アプリ自身のサイトなど、顧客をリンクさせる外部ホストをallowed_navigation_hostsに追加する。
- APIやCDNなど、アプリのコードが読み込みまたはリクエストを送信するサーバーをallowed_sourcesに追加する。
- shopify app deployを実行し、新しいバージョンをリリースする。
詳細
変更内容
通常、Shopifyは顧客がShopify外部のURLに遷移する際に警告を表示します。外部ホストを宣言することで、この警告をスキップし、信頼できる遷移における摩擦を取り除くことができます。一方でサーバーを宣言することは、Shopifyが不審なアクティビティを検出し、アプリを保護する助けになります。
新しいnetwork_accessセクションには、次の2つのプロパティがあります。
allowed_navigation_hosts:アプリがストアフロントからリンクする外部サイト(自社ドメインなど)。Shopifyは通常、顧客をストアフロント外のサイトへ送る前に警告を表示しますが、ここに記載したホストへのリンクはこの警告をスキップします。リンクに記載されている通りのホスト名を、最大20件までリストアップします。
allowed_sources:ストアフロント、チェックアウト、Shopify管理画面のページ上で、アプリのコードが読み込み元としたり、リクエスト送信先とするHTTPSオリジンを最大20件まで指定します。これにはエクステンション、アプリホーム、アプリプロキシページが含まれます。Shopifyはこのリストを使って、アプリを保護し、ストアフロントにおける悪意のあるリクエストを監視します。
設定例は以下の通りです。
[network_access]
allowed_navigation_hosts = ["app.example.com"]
allowed_sources = ["https://api.app.example.com"]
対象となるアプリ
ストアフロント、チェックアウト、またはShopify管理画面からコードが外部サーバーにリンクまたは通信を行うすべてのアプリが、この新しいセクションを利用できます。
実施すべきこと
すべてのアプリに対し、以下の対応が強く推奨されています。
- アプリが顧客をリンクさせるホスト(アプリ自身のサイトなど)をallowed_navigation_hostsに追加する。
- アプリのコードが読み込みまたはリクエストを送信するサーバー(APIやCDNなど)をallowed_sourcesに追加する。
- shopify app deployを実行し、新しいバージョンをリリースする。
設定例については、「Declare your app’s network access」のドキュメントを参照するよう案内されています。
[“Shopify”, “shopify.app.toml”, “network_access”, “Shopify CLI”, “アプリ開発”, “セキュリティ”]