Salesforce の External Services から API に接続

CData Connect AI を使用すると、Salesforce などのクラウドベースアプリケーションや Salesforce モバイルアプリなどのモバイルアプリケーションからAPI のデータにアクセスできます。この記事では、CData Connect AI を使用して Salesforce External Services 経由でAPI のデータにアクセスする方法をご紹介します。

Salesforce から your API に接続

概要

手順の概要は以下のとおりです。

1. 設定:（オプション）CData Connect AI で API データソースを設定し、ワークスペースを追加、ワークスペースにアセットを追加して、パーソナルアクセストークン（PAT）を生成します。
2. 接続: OpenAPI を使用して Salesforce を CData Connect AI にリンクします。
3. 活用: 接続したデータを Salesforce で使用します。

前提条件

開始する前に、以下を準備してください。

1. 有効な API アカウントと認証情報
2. CData Connect AI アカウント。こちらからログインまたは無料トライアルにサインアップしてください。
3. Salesforce アカウント

Connect AI から your API に接続

CData Connect AI は、シンプルなポイント＆クリックのインターフェースでデータソースに接続できます。

1. Connect AI にログインして「Sources」をクリック、次に「 Add Connection」をクリック

2. 接続を追加パネルから「API」を選択

3. your API に接続するために必要な認証プロパティを入力します。

   To connect to your API, configure the following properties on the Global Settings page:

   • In Authentication, select the Type and fill in the required properties
   • In Headers, add the required HTTP headers for your API
   • In Pagination, select the Type and fill in the required properties

   After the configuring the global settings, navigate to the Tables to add tables. For each table you wish to add:

   1. Click "+ Add"
   2. Set the Name for the table
   3. Set Request URL to the API endpoint you wish to work with
   4. (Optional) In Parameters, add the required URL Parameters for your API endpoint
   5. (Optional) In Headers, add the required HTTP headers for the API endpoint
   6. In Table Data click " Configure"
   7. Review the response from the API and click "Next"
   8. Select which element to use as the Repeated Elements and which elements to use as Columns and click "Next"
   9. Preview the tabular model of the API response and click "Confirm"
4. 「Save & Test」をクリック
5. your API 接続の追加ページで「Permissions」タブに移動し、ユーザーベースの権限を更新します。

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

REST API、OData API、または仮想 SQL Server を通じて Connect AI に接続する場合は、パーソナルアクセストークン（PAT）を使用して認証を行います。アクセス管理を細かく制御するため、サービスごとに個別の PAT を作成することをお勧めします。

1. Connect AI アプリの右上にある歯車アイコン（）をクリックして設定ページを開きます。
2. 設定ページで「Access Tokens」セクションに移動し、「 Create PAT」をクリックします。
3. PAT に名前を付けて「Create」をクリックします。
4. パーソナルアクセストークンは作成時にのみ表示されます。必ずコピーして、今後の利用のために安全に保管してください。

Salesforce 向けに your API エンドポイントを設定

your API への接続が完了したら、使用したいテーブル用のワークスペースを作成します。

1. 「Workspaces」ページに移動し、「 Add」をクリックして新しいワークスペースを作成します（または既存のワークスペースを選択）。
2. 「 Add」をクリックして、ワークスペースに新しいアセットを追加します。
3. your API 接続（例: API1）を選択し、「Next」をクリックします。
4. 使用したいテーブルを選択し、「Confirm」をクリックします。
5. ワークスペースの OpenAPI URL をメモしておきます（例: https://cloud.cdata.com/api/openapi/v3/{workspace_name}...）

選択したテーブルのカラムデータ型を確認

1. API のデータテーブルがアセットとして追加されたら、アセットを選択し、Columns タブからカラム名とデータ型をメモします。
2. Preview タブで、後で参照するためにテーブル内の現在のデータをプレビューします。
3. 左パネルから Users をクリックし、ユーザー名（例: [email protected]）を検索してクリックします。
4. Edit Users 画面で、該当のユーザーにエンティティ（ワークスペース）に対するすべての権限（Select、Insert、Update、Delete、Execute）を付与します。

接続、PAT、ワークスペースの設定が完了したら、Salesforce からAPI のデータに接続する準備は完了です。

API を External Service として接続

名前付き資格情報の作成

以下の手順に従って、CData Connect AI が生成する OpenAPI に Salesforce から接続します。

1. Salesforce にログインし、Setup に移動します。
2. 検索バーで Named Credentials を検索してクリックします。
3. New -> New Legacy を選択します。
4. New Named Credential 画面で以下の詳細を入力します。
   • Label: 任意のラベルを入力
   • Name: 名前付き資格情報の名前を入力
   • URL: https://cloud.cdata.com
   • Identity Type: Named Principal
   • Authentication Protocol: Password Authentication
   • Username: CData Connect AI のユーザー名を入力。CData Connect AI インターフェースの右上に表示されています（例: [email protected]）
   • Password: Settings ページで生成した PAT を入力
   • Generate Authorization Header: チェックボックスを有効化

Save をクリックして詳細を保存します。

External Service の作成

1. 検索バーで External Services を検索してクリックします。
2. Add an External Service ページで、Select an API Source の下の From API Specification をクリックします。
3. Enter an Existing Service ページで、Modify Exiting Registration Details の下に以下の詳細を入力します。
   • External Service Name: External Service を識別する名前を入力
   • Description: External Service の説明を入力（必須項目ではありません）
   • Service Schema: Relative URL
   • Select a Named Credential: OpenAPI
   • URL: Connect AI から OpenAPI URL をコピーし、https://www.cdata.com を削除して残りの URL を保持します。URL がスラッシュ "/api..." で始まっていることを確認してください。
   

   接続が成功すると、「Schema validation completed successfully!」というメッセージが画面に表示されます。Save & Next をクリックします。

4. Select Operations 画面ですべてのエンティティを選択します。Next をクリックします。
5. Review External Services Actions 画面に、スキーマから生成されたすべてのアクションが表示されます。Finish をクリックします。
6. External Services ページに、作成したすべての External Services が表示されます。

新しいフローの作成

1. 検索バーで Flows を検索してクリックします。
2. New Flow をクリックします。
3. Start From Scratch オプションを選択し、Screen Flow をクリックします。
4. Flow Builder 画面で、Screen Flow と End の間にある「」をクリックします。
5. Add Element から Screen を選択します。
6. New Screen ウィンドウで、Label に「Input Screen」と入力すると、API Name が自動的に入力されます。
7. 次に、更新したいテーブルに基づいて、フローに追加するコンポーネントのカラムデータ型をメモします。
8. orderid カラムの場合、Components 検索バーで「Number」コンポーネントを検索してクリックします。Label に「Enter Order ID」と入力すると、API Name が自動的に入力されます。Require チェックボックスを有効にし、手順 9 と 10 にも適用します。
9. ordername カラムの場合、Components 検索バーで「Text」コンポーネントを検索してクリックします。Label に「Enter Order Name」と入力します。
10. personid カラムの場合、Components 検索バーで「Number」コンポーネントを検索してクリックします。Label に「Enter Person ID」と入力します。
11. Done をクリックすると、Input Screen が Flow Builder に追加されます。
12. フロー内の Input Screen の下に Action エレメントを追加します。
13. Search Actions で、新しく作成した External Service（この場合は OpenAPI1）を検索してクリックします。
14. Create Orders をクリックします。
15. Label に名前を入力すると、API Name が自動的に入力されます。
16. Set Input Values for the Selected Action の下の検索バーをクリックし、 New Resource -> Variable を選択します。
17. New Resource ウィンドウで、以下の詳細を入力します。
    • Resource Type: Variable
    • API Name: Body
    • Data Type: Apex-Defined
    • Apex Class: ExternalService__CDataWorkspace2e
    • Availability Outside the Flow:
      • Available for input: チェックボックスを有効化
      • Available for output: チェックボックスを有効化
      
18. 新しいエレメント Assignment を追加し、Label name を「SendBody」にします。API Name は自動的に入力されます。
19. Set Variable Values の下に以下の値を設定します。
    • Variable: Body>orderid; Operator: Equals; Value: Input Screen>Enter Order ID
    • Variable: Body>ordername; Operator: Equals; Value: Input Screen>Enter Order Name
    • Variable: Body>personid; Operator: Equals; Value: Input Screen>Enter Person ID
    
20. Action エレメントの下にもう 1 つの Screen エレメントを追加します。
21. Label を「Display」にします。
22. Components で、「Display Text」コンポーネントを検索してクリックします。
23. API Name を「Display_Result」に設定し、Inside a resource 検索バーで Create a new order -> response code を選択します。Done をクリックします。
24. フローの準備ができました。Save をクリックしてフローを保存し、Label にフロー名（この場合は「CreateOrdersPage」）を追加します。Save をクリックします。
25. フローが Flow Builder 画面に表示されます。Activate をクリックしてフローを有効化します。

フローを確認し、Connect AI で更新内容を検証

1. Debug をクリックします。Debug flow ウィンドウが開きます。Run をクリックします。
2. 詳細入力ページ（この場合は「CreateOrdersPage」）で、詳細（Orders ID、Orders Name、Person ID）を入力し、Next をクリックします。
3. 次のページに「200」（HTTP 200 - OK）というメッセージが表示され、右ペインにデバッグ詳細が表示されます。Next をクリックします。
4. 入力を変更したり、プロセスを再実行して新しい詳細を入力できます。
5. Connect AI で、この記事で説明したように「Orders」テーブルに新しい詳細が更新されているか確認します。これでプロセスは完了です。

クラウドアプリケーションからAPI のデータへの簡単なアクセス

これで、Salesforce からAPI のデータへのダイレクトなクラウド間接続が完成しました。100 以上の SaaS、ビッグデータ、NoSQL ソースへのクラウドアプリケーション経由でのライブデータアクセスの詳細については、CData Connect AI のページをご覧ください。

ご質問がございましたら、サポートチームまでお問い合わせください。