App Builder を使ってローコードでShopify と連携したBlazor アプリを作成

杉本和也
リードエンジニア

CData Connect AI を使ってShopify のデータの仮想OData API エンドポイントを作成して、App Builder のダッシュボードでShopify のデータを可視化・分析する方法。

App Builder はインフラジスティックス社が提供している「ドラッグアンドドロップで迅速なアプリケーション開発作成を可能にする」ローコードツールです。この記事では、CData Connect AI を経由して App Builder からShopify に連携するBlazor アプリを作成する方法を説明します。

CData Connect AI は、Shopify のデータのクラウド to クラウドの仮想OData インターフェースを提供し、App Builder からリアルタイムにShopify のデータへ連携することができます。

CData Connect AI の設定

App Builder でShopify のデータをリアルタイムで操作するには、Connect AI からShopify に接続し、コネクションにユーザーアクセスを提供してShopify のデータのOData エンドポイントを作成する必要があります。

（オプション）新しいConnect AI ユーザーの追加

必要であれば、Connect AI 経由でShopify に接続するユーザーを作成します。

ユーザーページに移動し、 Invite Users をクリックします。
新しいユーザーのE メールアドレスを入力して、 Send to invite the user をクリックします。
ユーザーページからユーザーを確認および編集できます。

パーソナルアクセストークンの追加

OAuth 認証をサポートしていないサービス、アプリケーション、プラットフォーム、またはフレームワークから接続する場合は、認証に使用するパーソナルアクセストークン（PAT）を作成できます。きめ細かなアクセス管理を行うために、サービスごとに個別のPAT を作成するのがベストプラクティスです。

Connect AI アプリの右上にあるユーザー名をクリックし、User Profile をクリックします。
User Profile ページでPersonal Access Token セクションにスクロールし、 Create PAT をクリックします。
PAT の名前を入力して Create をクリックします。
パーソナルアクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。

Connect AI からShopify に接続

CData Connect AI では、簡単なクリック操作ベースのインターフェースでデータソースに接続できます。

Connect AI にログインし、 Add Connection をクリックします。
Add Connection パネルから「Shopify」を選択します。
必要な認証プロパティを入力し、Shopify に接続します。
それでは、Shopify への接続・認証について説明していきましょう。Shopify では、アクセストークンとOAuth の2つの接続方法をサポートしています。

アクセストークンによる接続

アクセストークン経由の接続には、以下の2つのステップが必要です。
1. Shopify の管理画面でアクセストークンを作成
2. アクセストークンを使用して認証
アクセストークンの作成

まず、アプリを登録してアクセストークンを取得してみましょう。手順は以下のとおりです。
1. 管理画面からShopify にログインし、Apps → Apps and sales channels に進みます
2. Develop apps をクリックしてCreate an app を選択します
3. Overview タブのConfiguration で、Admin API integration をクリックし、アプリに許可するストアのアクセス権を選択してください。CData製品が必要とするAdmin API 権限については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」セクションをご確認ください
4. Save をクリックします
5. Overview タブのConfiguration で、Storefront API integration をクリックし、アプリに許可するストアのアクセス権を選択します。CData製品が必要とするStorefront API 権限は以下のとおりです：
  - unauthenticated_read_content
6. Save をクリックします
7. API Credentials を選択します
8. "Access tokens" の下でInstall app をクリックします。これでアクセストークンが作成されます
9. Admin API Access token のアクセストークンをコピーします。注意：トークンの公開およびコピーは1回のみ可能ですので、必ず保存してください
アクセストークンによる認証

続いて、アクセストークンで認証するには、以下のプロパティを設定してください。
- AuthScheme：AccessToken に設定
- AccessToken：カスタムアプリからコピーしたアクセストークンの値に設定
OAuth 認証を介した接続については、ヘルプドキュメントの「OAuth 認証の使用」をご確認ください。
Create & Test をクリックします。
Edit Shopify Connection ページのPermissions タブに移動し、ユーザーベースのアクセス許可を更新します。

Connect AI にShopify OData エンドポイントを追加する

Shopify に接続したら、目的のテーブルのOData エンドポイントを作成します。

OData ページに移動し、 Add to create new OData endpoints をクリックします。
Shopify 接続（例：Shopify1）を選択し、Next をクリックします。
使用するテーブルを選択し、Confirm をクリックします。

コネクションとOData エンドポイントを設定したら、App Builder からShopify のデータに接続できます。

App Builderでプロジェクトを作成する

Web API の準備ができたら、App Builder で作業を進めていきます。

App Builder を立ち上げて「＋新しいアプリ」をクリックします。

テンプレートから任意のものを選択します。

これでアプリを作成するための下準備が整いました。

データソースの追加

前述の通りApp Builder ではREST API に接続したアプリを手軽に作成することができます。API 接続部分はあらかじめデータソースとして定義しておくことで、簡単にUI とバインドすることができるようになるので、まずはこのデータソースの準備を進めます。

画面左の「データ」タブに移動し新しく「REST API」を追加します。

「REST API データソースの設定」で任意の名称を入力し、ソースとして「OpenAPI」または「URL の追加」を選択します。今回はOpenAPI の手順で解説します。OpenAPI を使わない場合は「URL の追加」で手動で設定します。

ここでは先程CData Connect AI からダウンロードしておいたOpenAPI の定義を使用するので「定義のアップロード」をクリックします。

アップロードが完了したら「エンドポイントの設定」をクリックします。

「エンドポイントの設定」ではOpenAPI で定義されているエンドポイントの一覧の中から利用するものを選択し、App Builder で利用するデータソースとして定義します。今回はデータの一覧が取得できるGET エンドポイントを指定し、事前に作成したユーザーID・トークンを使って必要な認証情報を入力します。
「送信」をクリックして「200OK」を受け取ったら接続はOKです。