UI/UX 特化ローコード開発ツール NEXACRO BEYOND を使ってGMO MakeShop と連携したアプリを開発する方法

杉本和也
杉本和也
リードエンジニア
CData API Server を使ってGMO MakeShop のデータのOData API エンドポイントを作成して、NEXACRO BEYOND からGMO MakeShop のデータを使ったアプリを作成する方法。



NEXACRO BEYOND は UI/UX に特化したローコード開発ツールおよびその実行基盤です。この記事では、CData API Server を経由して NEXACRO BEYOND からGMO MakeShop に連携し、アプリを開発する方法を紹介します。

CData API Server は、GMO MakeShop のデータの仮想OData インターフェースを提供し、NEXACRO BEYOND からリアルタイムにGMO MakeShop データへ連携することができます。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなGMO MakeShop OData サービスを作成していきましょう。

GMO MakeShop への接続

Nexacro からGMO MakeShop のデータを操作するには、まずGMO MakeShop への接続を作成・設定します。

  1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。 接続を追加
  2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「GMO MakeShop」を選択します。
  3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
    CData コネクタの追加方法はこちら >>
  4. それでは、GMO MakeShop への接続設定を行っていきましょう! 接続設定
  5. 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 を実行する場合に必要です。
  6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

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 を実行する場合に必要です。

API Server のユーザー設定

次に、API Server 経由でGMO MakeShop にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

  1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
  2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
  3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

GMO MakeShop 用のAPI エンドポイントの作成

ユーザーを作成したら、GMO MakeShop のデータ用のAPI エンドポイントを作成していきます。

  1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。
  2. アクセスしたい接続を選択し、次へをクリックします。
  3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でGMO MakeShop への接続を設定してユーザーを作成し、API Server でGMO MakeShop データのAPI を追加しました。これで、OData 形式のGMO MakeShop データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

プロジェクトの作成

Web API の準備が整ったのでNEXACRO BEYOND によるアプリケーション開発を進めていきます。NEXACRO BEYOND のアプリケーションは NEXACRO Studio というツールを用いて開発します。

  1. まず、NEXACRO Studio を立ち上げて新しいプロジェクトを作成しましょう。
  2. 任意の名称でProject を作成します。
  3. 作成するアプリケーションの種類は今回はDesktop としました。
  4. Template から「Full」を選択して、「Finish」をクリックします。

Form の作成

プロジェクトを作成したら、一覧画面を表示するためのForm を作成しておきます。

  1. 「File」→「New」→「Form(.xfdl)」を選択し
  2. 任意の名称でEmpty Form を作成します。
  3. 以下のようにフォームが表示できればOKです。

DataObject の作成

続いてWeb API との通信の部分を作り込んでいきます。NEXACRO BEYOND ではDataObject という機能を用いて、JSON フォーマットのWeb API との通信やデータ制御を行うようになっています。

  1. まず「DataObject」を画面に配置します。
  2. DataObject を配置すると、Invisible Object の一覧に配置したDataObject が表示されるので右クリックから「Edit」を選択します。
  3. このJson Content Editor でJSON のオブジェクト構造を確認します。ここで先ほどCData API Server で定義したリソースのエンドポイントを指定します。その際にクエリパラメータでの認証も入力しておきましょう。
  4. 併せて、今回はアプリケーションを実行したときに通信が行われるように「preload」を「true」に指定しておきました。

Dataset を構成する

今回は最終的に一覧画面を作るわけですが、一覧画面のコンポーネントはJSON のように不定形なオブジェクトだとバインディングすることができません。

そこで、一度DataObject を「Dataset」という画面上で利用できるオブジェクトにマッピングしてあげた上で、UI 上で表示できるようにします。

  1. 「Dataset」を先ほどと同じように画面に配置します。
  2. 作成したDataset の「binddataobject」で先ほど作成したDataObject を選択し、次に「dataobjectpath」を編集します。
  3. 以下のようなData Path Editor という画面で、JSON のオブジェクト構造をどのようにマッピングするかを構成できます。
  4. CData API Server で作成されたWeb API「$.value」というJSON Path でレコードに分解できます。そのため DataObject Path に「$.value [*]」と入力して、リロードし、各カラムをマッピングさせます。

Grid の作成

最後に一覧表示用のGrid を配置して、取得したデータを表示してみましょう。

  1. Grid をキャンパス上に配置します。
  2. Grid を配置後、先ほど定義したDataset をGrid 上にドラッグ・アンド・ドロップで持っていくと、以下のよう一覧画面が表示されます。

このように、CData API Server を経由することで、API 側の複雑な仕様を意識せずにAPI 連携アプリをNEXACRO BEYOND で開発できます。他にも多くのデータソースに対応するCData API Server の詳細をこちらからご覧ください。