Admin / 改善

管理画面で作ったカスタムアプリが
Dev Dashboard に表示されるように

管理画面で作ったレガシーのカスタムアプリが Dev Dashboard に表示されるようになった。そこで「IP アドレス制限」と「API・Webhook のログ確認」が使える。動いている連携はそのまま動き続ける。

このページの構成
  1. 何が変わったのか(30秒で理解)
  2. 図解 : 移ったあとのアプリの位置づけ
  3. Dev Dashboard で使えるようになる 2 つの機能
  4. 変わらないもの(連携は動き続ける)
  5. 従来 vs 今後の比較
  6. 今後の作成・管理フロー
  7. 技術者が押さえるべき5つのポイント
  8. 業務に活かせる3つのユースケース
  9. 提案で使える1行サマリ

1何が変わったのか

Shopify 管理画面で作った レガシーのカスタムアプリ が、Dev Dashboard に表示されるようになった。
Dev Dashboard では、認証情報を守る機能とアプリの動きを監視する機能(IP 制限・リクエストログ)が使える。

これまで : 管理画面で作成・管理

ストアの管理画面でカスタムアプリを作って管理していた。

今後 : Dev Dashboard で管理

既存のアプリは Dev Dashboard で管理する。新しく作るときは Dev Dashboard か Shopify CLI を使う。

2図解 : 移ったあとのアプリの位置づけ

ストア カスタムアプリ(インストール済み) トークン・スコープ・Webhook そのまま維持 連携は止まらない 表示・管理先 Dev Dashboard 管理画面で作った既存カスタムアプリ IP 制限 認証情報を守る ログ確認 API / Webhook 許可した IP だけが 認証情報を使える 怪しい動きの調査と トラブル対応が早くなる
移行の具体的なスケジュール(全ストア一斉か段階的か、いつ終わるか)は記載なし。記事は「今は Dev Dashboard に表示されている」と伝えているだけ。

3Dev Dashboard で使えるようになる 2 つの機能

セキュリティ

IP アドレスで制限する

アプリの認証情報を使える IP アドレスを絞れる。決めた場所以外からは使えなくなる。

モニタリング

API と Webhook の動きを見る

アプリが送ったリクエストと受け取った Webhook のログを見られる。怪しい動きの調査やトラブル対応が早くなる。

ログの保存期間、IP 制限で登録できる数、CIDR 表記が使えるか、料金については記載なし。

4変わらないもの(連携は動き続ける)

アプリはインストールされたまま
ストアから外れない
アクセストークン・スコープ
今のトークンとスコープがそのまま使える
Webhook
今の Webhook もそのまま動く
記事には「連携は動き続ける」と書いてある。トークンの再発行やアプリの入れ直しが必要だという話は記載なし。

5従来 vs 今後の比較

項目従来(管理画面のカスタムアプリ)今後(Dev Dashboard)
管理する場所 管理画面 Dev Dashboard
新しく作る方法 管理画面から作る Dev Dashboard / Shopify CLI
IP アドレス制限 記載なし 使える
API / Webhook のログ 記載なし 見られる
トークン・スコープ・Webhook — そのまま使える

6今後の作成・管理フロー

1

既存アプリを Dev Dashboard で確認

管理画面で作ったカスタムアプリが Dev Dashboard に出ているか見る。

2

IP 制限とログを使う

認証情報を使える IP を絞る。リクエストと Webhook のログで動きを確かめる。

3

新しいアプリは Dev Dashboard / CLI で作る

新しいカスタムアプリは Dev Dashboard か Shopify CLI で作る。

詳しくは Dev Dashboard のカスタムアプリについての開発者ドキュメントを見る。具体的な画面操作は記事に記載なし。

7技術者が押さえるべき5つのポイント

1. 動いている連携はそのまま

今のアクセストークン、スコープ、Webhook はそのまま使える。連携側のコードを今すぐ直す必要があるとは書かれていない。

2. IP 制限は呼び出し元の把握が先

IP 制限を入れると、許可していない IP からは認証情報が使えなくなる。サーバー、バッチ、外部の SaaS など、どこから呼んでいるかを先に洗い出しておく。

3. ログで送受信の両方が見える

アプリが送った API リクエストと、受け取った Webhook の両方が見える。Webhook が届かない、API がエラーになる、といったときに最初に見る場所になる。

4. 新しく作るときは Dev Dashboard / CLI

新しいカスタムアプリは Dev Dashboard か Shopify CLI で作る。社内の作業手順書や構築手順を更新しておく。

?

5. 書かれていないこと

管理画面でカスタムアプリを作れなくなる日、廃止の予定、Dev Dashboard の権限(誰がアクセスできるか)、ログの保存期間、API での操作は記載なし。運用ルールを決める前に開発者ドキュメントで確認する。

8業務に活かせる3つのユースケース

基幹システム
USE CASE 1

基幹システムとの連携トークンを IP 制限で守る

課題
在庫や受注の連携を管理画面のカスタムアプリで動かしている。トークンが漏れたら、どこからでも使われてしまうのが心配。
打ち手
Dev Dashboard で、連携サーバーの IP アドレスだけが認証情報を使えるように制限する。
効果
トークンが漏れても、許可していない場所からは使えない。セキュリティ審査で説明しやすい。
技術メモ
先に呼び出し元の IP をすべて洗い出す。固定 IP でない環境(一部のクラウド実行環境など)は要注意。登録できる数や書き方は記載なし。
USE CASE 2

「Webhook が届かない」問い合わせの原因を早く切り分ける

課題
「注文が連携先に来ていない」という問い合わせのとき、Shopify 側と自社サーバー側のどちらに原因があるか分けるのに時間がかかる。
打ち手
Dev Dashboard のログで、アプリが受け取った Webhook と送った API リクエストを確認する。
効果
原因の場所がすぐ分かり、トラブル対応の時間が短くなる。
技術メモ
ログの保存期間や検索の条件は記載なし。長く保存したいなら、自社側のログも並行して残しておく。
管理画面 Dev Dashboard
USE CASE 3

制作会社の運用手順を Dev Dashboard に揃える

課題
ストアごとに管理画面でカスタムアプリを作って渡していて、作り方と管理する場所がバラバラ。
打ち手
新しいカスタムアプリは Dev Dashboard か Shopify CLI で作る。既存のアプリも Dev Dashboard で一覧・管理するように手順書を書き換える。
効果
作り方と管理する場所が揃い、引き継ぎや確認がしやすくなる。
技術メモ
CLI で作れば構築の手順を自動化しやすい。Dev Dashboard のアクセス権を誰に渡すかは記載なしなので、別途確認する。

9提案で使える1行サマリ

「管理画面で作ったカスタムアプリが Dev Dashboard で管理できるようになった。
連携は止まらない。そのうえで IP 制限とログ確認が使える。
まずは呼び出し元の IP を洗い出し、トークンを守ろう。」