Unqork でGMO MakeShop に接続されたアプリケーションを作成

こんにちは！リードエンジニアの杉本です。

概要

CData Connect Cloud を使えば、Unqork からGMO MakeShop のデータを取得できます。そのデータを使って、カスタムの業務アプリケーションをドラッグドロップ操作で作成できます。この記事ではそのための手順を説明します。

Unqork はあらゆる操作を視覚的に実行できるノーコードの開発プラットフォームで、大企業の複雑なカスタムソフトウェア作成を支援します。CData Connect Cloud はGMO MakeShop をREST エンドポイントとして公開するので、Unqork 側で簡単なHTTP リクエストを使ってクエリできます。この方法で、GMO MakeShop のデータを使ったカスタムアプリケーションを作成できます。

この記事を読んでわかること

本記事では、次の点について説明します。

• CData Connect Cloud のユーザーを追加する方法。
• Connect Cloud ユーザー用のパーソナルアクセストークンを追加する方法。
• Connect Cloud からGMO MakeShop に接続する方法。
• Connect Cloud にGMO MakeShop OData エンドポイントを追加する方法。
• Connect Cloud 経由でGMO MakeShop をUnqork サービスとして登録する方法。
• GMO MakeShop のデータを表示するための簡単なUnqork アプリケーションを作成する方法。

CData Connect Cloud を構成する

Unqork からGMO MakeShop のデータを扱うには、以下の手順が必要です。

• CData Connect Cloud からGMO MakeShop に接続。
• CData Connect Cloud で新しいコネクションにユーザーアクセス権限を追加。
• GMO MakeShop のデータのOData エンドポイントを作成。

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

必要な際には、Connect Cloud 経由でGMO MakeShop に接続するユーザーを作成してください。

1. Users ページに移動して、 Invite Users をクリックします。
2. 新しいユーザーのE メールアドレスを入力して、 Send to invite the user をクリックします。
3. Users ページからユーザーを確認、変更できます。

パーソナルアクセストークンを追加する

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

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

Connect Cloud からGMO MakeShop に接続する

CData Connect Cloud は直感的なクリック操作ベースのインターフェースを使ってデータソースに接続します。
1. Connect Cloud にログインし、 Add Connection をクリックします。
2. Add Connection パネルから「GMO MakeShop」を選択します。
3. 必要な認証情報を入力し、GMO MakeShop に接続します。

   GMO MakeShop に接続するには、MembersAccessCode、OrdersAccessCode、ProductsAccessCode、およびShopId が必要です。

   GMO MakeShop へのアクセスの設定

   MembersAccessCode、OrdersAccessCode、ProductsAccessCode、およびShopId を取得するには、以下の手順に従ってください。

   • GMO MakeShop には各API のAccessCode が必要です。
   • GMO MakeShop Store Manager にログインし、メニューの「ショップ作成」をクリックします。
   • 左ナビゲーションメニューの「外部システム連携」から任意の連携対象設定ををクリックします（メニューに表示されない場合は別途GMO MakeShop にご確認ください）。
   • 商品データ連携設定の場合：認証コードの「発行」ボタンをクリックし、ProductsAccessCode を取得します。
   • 注文データ連携設定の場合：最初に「注文情報参照」と「注文情報変更」の設定を選択します。選択後、認証コードの「発行」ボタンをクリックし、OrdersAccessCode を取得します。
   • 会員データ連携設定の場合：最初に「会員情報の（参照・登録・変更・削除）」の設定を選択します。選択後、認証コードの「発行」ボタンをクリックし、MembersAccessCode を取得します。
   • 会員認証連携設定の場合：認証コードの「発行」ボタンをクリックし、ProductsAccessCode を取得します。

   GMO MakeShop アカウントの認証

   次の接続プロパティを設定して接続します。

   • ShopId：接続先のGMO MakeShop Store ID を設定。GMO MakeShop Store ID はログイン用の ID と同じです。
   • OrdersAccessCode：「注文データ連携設定」から取得した「認証コード」を設定。このプロパティは Orders テーブルにアクセスする場合に必要です。
   • ProductsAccessCode：「商品データ連携設定」から取得した「認証コード」を設定。このプロパティは Products テーブルにアクセスする場合に必要です。
   • MembersAccessCode：「会員データ連携設定」から取得した「認証コード」を設定。このプロパティは Members テーブルにアクセスする場合に必要です。
   • MemberAuthenticationCode：「会員認証連携設定」から取得した「認証コード」を設定。このプロパティは MemberAuthenticationConfirm を実行する場合に必要です。
   • Password：GMO MakeShop Store Manager のログインユーザーのパスワードを指定。このプロパティは ProductCategoryRegistrationOrModification,ProductMemberGroupPriceRegistrationOrModification,ProductOptionRegistrationOrModification,ProductRegistrationOrModification を実行する場合に必要です。
   
4. Create & Test をクリックします。
5. Add GMO MakeShop Connection ページのPermissions タブに移動し、ユーザーベースのアクセス許可を更新します。

Connect Cloud にGMO MakeShop のOData エンドポイントを追加する

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

1. OData ページに移動して、 Add をクリックそ新しいOData エンドポイントを作成します。
2. GMO MakeShop のコネクション（例：GMOMakeShop1）を選択し、Next をクリックします。
3. 使用するテーブルを選択し、Confirm をクリックします。

OData フィードのサンプルURL

GMO MakeShop への接続を構成してユーザーを作成し、Connect Cloud でOData エンドポイントを作成すると、GMO MakeShop のデータのOData フィードにアクセスできるようになります。 以下は、テーブルにアクセスするためのURL とテーブルのリストです。テーブルへのアクセスについては、Connect Cloud のOData ページを参照してください。 URL はConnect Cloud のものが必要です：https://cloud.cdata.com/api/odata/service。

テーブル		URL
エンティティ（テーブル）一覧		https://cloud.cdata.com/api/odata/service/
メタデータ		https://cloud.cdata.com/api/odata/service/$metadata
Products		https://cloud.cdata.com/api/odata/service/Products

通常のOData フィードについては、返されるフィールドを制限したい場合は、クエリに$select パラメータと$filter、$orderby、$skip、$top といった他の一般的なOData URL パラメータを組み合わせて追加できます。 サポートされているOData クエリの詳細についてはヘルプドキュメントを参照してください。

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

GMO MakeShop のデータを使った簡単なアプリケーションを作成

Connect Cloud でGMO MakeShop のREST API を設定したら、GMO MakeShop に接続したアプリケーションをUnqork で作成できます。以下がそのための基本的な手順です。

• GMO MakeShop をUnqork サービスとしてConnect Cloud 経由で登録
• Unqork 内にワークスペースを作成
• module-type のアプリケーションを作成

GMO MakeShop をUnqork サービスとしてConnect Cloud 経由で登録

Connect Cloud に接続するには、ご利用の環境に外部サービスへの接続権限を付与する必要があります。Services Administration から付与を実行してください。

1. Unqork Designer Platform の右上端にある、Settings ドロップダウンメニューをクリックします。
2. Administration をクリックします。
3. Integrations 以下の、Services Administration をクリックします。
4. Service Title を入力します。例えば、Connect Cloud。
5. Service Name を入力します。例えば、cdataConnect。
6. Service protocol + host を入力します。これは参照したいAPI エンドポイントのことです。例えば、 https://cloud.cdata.com/api/odata/service。
7. Type of Authentications ドロップダウンメニューからBasic Auth を選択します。
8. Connect Cloud のユーザーID（例：user@mydomain.com）をUser Name フィールドに入力します。
9. Connect Cloud のユーザーのPAT をPassword フィールドに入力します。
10. Add Service をクリックします。

Workspace を作成する

Unqork では自身のワークスペースを作成することができ、それが自身やチームがアプリケーションを保存したり整理したりする仮想コンテナとなります。ワークスペースを作成したら、そこにアプリケーションを追加できます。

ワークスペースを作成するには、以下の手順を実行します。

1. Create Workspace をクリックします。
2. 一意のWorkspace Name を入力します。
3. Create をクリックします。

作成したワークスペースタイルがWorkspaces タブ以下に表示されます。

Module-Type のアプリケーションを作成する

ワークスペースを追加したら、アプリケーションを作成できます。module-type もしくはworkflow-type のアプリケーションを選択できます。今回の例では、module-type のアプリケーションを作成します。

1. 開いたワークスペースからApps に移動します。
2. Create Workspace をクリックします。
3. 一意のApp Name を入力します。
4. Style ドロップダウンメニューからプレビュースタイルを選択します。スタイルはアプリケーションの外観を指定します。空白にした場合は、アプリケーションは環境のデフォルトスタイルを使用します。
5. App Type ドロップダウンメニューからModule を選択します。
6. App Entrypoint Module ドロップダウンメニューからNew Entrypoint Module を選択します。
7. Create をクリックします。

新しいアプリケーションのModules タブに移動します。次のように表示されます。



モジュールに名前をつけるには、Module Editor でタイトルをクリックします。

アプリケーションの作成を完了するには、次のコンポーネントが必要です。

• Hidden コンポーネント：Plug-In で取得したデータを格納します。
• Initializer コンポーネント：テーブルを表示する際にPlug-In を実行します。
• Plug-In コンポーネント：Connect Cloud からGMO MakeShop のデータを取得してHidden コンポーネントに格納します。
• ViewGrid コンポーネント：Hidden コンポーネントに格納したデータからHTML テーブルを作成します。

Hidden コンポーネントを設定する

Hidden コンポーネントはConnect Cloud から取得したGMO MakeShop のデータを格納します。

1. Hidden コンポーネントをキャンバスにドラッグドロップします。
2. Property ID とCanvas Label Text を入力します。
   

   NOTE：Property ID はキャメルケース（camelCase のように）にする必要があります。例えば、hiddenComponent です。Hidden コンポーネントユーザーには表示されないので、Property ID をCanvas Label Text として使用してください。

3. Save をクリックします。

Plug-In コンポーネントを設定する

次に、Connect Cloud にデータをリクエストするためのPlug-In コンポーネントを追加します。このコンポーネントは、Service Administration で設定したサービスに接続します。

1. Plug-In コンポーネントを、キャンバスのHidden コンポーネントの下にドラッグドロップします。
2. Property ID とCanvas Label Text を入力します。

   NOTE：キャメルケース（camelCase のように）を使用する必要があります。Plug-In のProperty ID はplugin で始めるのがベストプラクティスです。例えば、pluginGetAWProducts。

3. Outputs テーブルを次のように設定します。
   • Hidden コンポーネントのProperty ID をProperty ID カラムに入力します。
   • value をMapping カラムに入力します。
4. Service Type としてExternal を選択します。
5. External Services ドロップダウンメニューから、Connect Cloud サービスを選択します。これは、Services Administration で設定した外部サービスです。
6. Data Sources URL の最後にConnect Cloud リソースの特定のエンドポイントを追加します。例えば、AdventureWorks2012_Production_Product です。

   NOTE：データソースのURL は、https://cloud.cdata.com/api/odata/service/AdventureWorks2012_Production_Product と類似の値となります。

7. Save をクリックします。

Initializer コンポーネントを設定する

Initializer コンポーネントは、GMO MakeShop のデータを取得するPlug-In を実行するためのものです。

1. Initializer コンポーネントを、キャンバスのPlug-In コンポーネントの上にドラッグドロップします。
2. Property ID とCanvas Label Text を入力します。

   NOTE：キャメルケース（camelCase のように）を使用する必要があります。Initializer のProperty Name はinit で始めるのがベストプラクティスです。例えば、initGetAWProducts です。
   

3. Trigger Type としてNew Submission を設定します。
4. Outputs テーブル内に次を入力します。
   • Plug-In のProperty ID をProperty ID カラムのフィールドに入力します。
   • Type カラムのフィールドにtrigger と入力します。
   • Value カラムのフィールドにGO と入力します。
5. Save をクリックします。

ViewGrid コンポーネントを設定する

ViewGrid コンポーネントはHidden コンポーネントに格納されたデータを参照します。その後、ダッシュボード（またはテーブル）にGMO MakeShop のデータを表示します。

1. ViewGrid コンポーネントを、キャンバスのPlug-In コンポーネントの下にドラッグドロップします。
2. Label とProperty Name を入力します。

   NOTE：キャメルケース（camelCase のように）を使用する必要があります。ViewGrid のProperty Name はvg で始めるのがベストプラクティスです。例えば、vgAWProductView です。

3. Inputs テーブルで、id をHidden コンポーネントのProperty ID に設定します。
4. Display テーブルで次を設定します。
   • id カラム内に、表示したいフィールドのID を入力します。
   • handing カラムに、各フィールド用のタイトルを入力します。フィールドは、自身とユーザーに次のように表示されます。
   
5. Save をクリックします。
6. Save ボタンでモジュールを保存します。

上のコンポーネントを追加、設定したら、アプリケーションの自身とユーザーへの表示をプレビューできます。Module Editor で、Preview Module をクリックしてモジュールの前からの表示（"Express View"）を確認できます。

Express View モジュールは次のように表示されます。



詳細と無料トライアル

Connect Cloud とUnqork を組み合わせれば、GMO MakeShop に接続できるアプリケーションを簡単に作成できます。Connect Cloud の無償トライアルを始めてUnqork からすぐにGMO MakeShop のデータにアクセスしましょう。