ローコードアプリ開発プラットフォームOutSystems でBigCommerce 連携アプリを作成

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

CData API Server を使ってBigCommerce のデータの仮想OData API エンドポイントを作成して、OutSystems からBigCommerce のデータを使ったアプリを作成する方法。

OutSystemsは、アプリケーションをUI 上で開発できるローコード開発プラットフォームです。この記事では、CData API Server を経由して OutSystems からBigCommerce に連携するアプリを作成する方法を説明します。

CData API Server は、BigCommerce のデータのクラウド to クラウドの仮想OData インターフェースを提供し、OutSystems からリアルタイムにBigCommerce のデータへ連携することができます。さらに、CData API Server は OpenAPI の定義ファイルを取得できるため、OutSystems で自動的にREST API Method を定義してスムーズにアプリ開発を行うことができます。

API Server の設定

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

BigCommerce への接続

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

API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「BigCommerce」を選択します。
事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >>
それでは、BigCommerce への接続設定を行っていきましょう！
BigCommerce 認証は標準のOAuth フローに基づいています。
Store ID の取得

BigCommerce Store に接続するには、StoreId が必要です。Store Id を確認するには、以下の手順に従ってください。
1. BigCommerce アカウントにログインします。
2. ホームページから「Advanced Settings」->「API Accounts」 を選択します。
3. 「Create API Account」->「Create V2/V3 API Token」をクリックします。
4. 画面にAPI Path という名前のテキストボックスが表示されます。
5. テキストボックス内に、次の構造のURL が表示されます：https://api.bigcommerce.com/stores/{Store Id}/v3。
6. 上記で示したように、Store Id は'stores/' と'/v3' パスパラメータの間にあります。
7. Store Id を取得したら、「キャンセル」 をクリックするか、まだ持っていない場合はAPI Account の作成に進むことができます。
パーソナルアクセストークンの取得

加えて、自分のデータをテストおよびアクセスするには、個人用トークンを取得する必要があります。個人用トークンを取得する方法は次のとおりです。
1. BigCommerce アカウントにログインします。
2. ホームページから「Advanced Settings」->「API Accounts」 を選択します。
3. 「Create API Account」->「Create V2/V3 API Token」をクリックします。
4. アカウント名を入力します。
5. 作成するAPI Account の「OAuth Scopes」を選択します。CData 製品は"None" とマークされたデータにアクセスできません。また、"read-only" とマークされたデータを変更できません。
6. 「保存」をクリックします。
BigCommerce への認証

次に、以下を設定してデータに接続できます。
- StoreId：API Path テキストボックスから取得したStore ID に設定。
- OAuthAccessToken：生成したトークンに設定。
- InitiateOAuth：OFF に設定。
接続情報の入力が完了したら、「保存およびテスト」をクリックします。

BigCommerce 認証は標準のOAuth フローに基づいています。

Store ID の取得

BigCommerce Store に接続するには、StoreId が必要です。Store Id を確認するには、以下の手順に従ってください。

BigCommerce アカウントにログインします。
ホームページから「Advanced Settings」->「API Accounts」 を選択します。
「Create API Account」->「Create V2/V3 API Token」をクリックします。
画面にAPI Path という名前のテキストボックスが表示されます。
テキストボックス内に、次の構造のURL が表示されます：https://api.bigcommerce.com/stores/{Store Id}/v3。
上記で示したように、Store Id は'stores/' と'/v3' パスパラメータの間にあります。
Store Id を取得したら、「キャンセル」 をクリックするか、まだ持っていない場合はAPI Account の作成に進むことができます。

パーソナルアクセストークンの取得

加えて、自分のデータをテストおよびアクセスするには、個人用トークンを取得する必要があります。個人用トークンを取得する方法は次のとおりです。

BigCommerce アカウントにログインします。
ホームページから「Advanced Settings」->「API Accounts」 を選択します。
「Create API Account」->「Create V2/V3 API Token」をクリックします。
アカウント名を入力します。
作成するAPI Account の「OAuth Scopes」を選択します。CData 製品は"None" とマークされたデータにアクセスできません。また、"read-only" とマークされたデータを変更できません。
「保存」をクリックします。

BigCommerce への認証

次に、以下を設定してデータに接続できます。

StoreId：API Path テキストボックスから取得したStore ID に設定。
OAuthAccessToken：生成したトークンに設定。
InitiateOAuth：OFF に設定。

API Server のユーザー設定

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

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

BigCommerce 用のAPI エンドポイントの作成

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

まず、「API」ページに移動し、「テーブルを追加」をクリックします。
アクセスしたい接続を選択し、次へをクリックします。
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
併せて OutSystemsにAPIリクエストの仕様を取り込むためにAPI ページ（https://myserver/api.rst#oas）にある「Open API」のファイルを以下から保存しておきましょう。

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

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