Salesforce Connect で REST 外部オブジェクトを編集・検索（API Server）

Jerod Johnson
Jerod Johnson
Senior Technology Evangelist
API Server を使用して、スマートデバイスやクラウドベースのアプリケーションにREST のデータのセキュアな OData フィードを提供します。API Server と Salesforce Connect を使用して、アプリやダッシュボードからアクセスできる REST オブジェクトを作成します。

CData API Server を使用すると、Salesforce コンソールや Salesforce1 モバイルアプリなどのクラウドベースのアプリケーションからREST のデータにアクセスできます。この記事では、API Server と Salesforce Connect を使用して、標準の Salesforce オブジェクトと一緒に REST 外部オブジェクトにアクセスする方法を説明します。

API Server のセットアップ

まだインストールしていない場合は、CData API Server をダウンロードしてください。API Server をインストールしたら、以下の手順に従ってセキュアな REST OData サービスの作成を開始します。

REST への接続

Salesforce Connect からREST のデータを操作するには、まず REST への接続を作成・設定します。以下の手順で API Server を設定してREST のデータに接続します。

  1. まず、Connections ページに移動します。
  2. Add Connection をクリックし、REST 接続を検索して選択します。
  3. REST に接続するために必要な認証プロパティを入力します。

    データソースへの認証については、データプロバイダーのヘルプドキュメントの「はじめに」を参照してください: データプロバイダーはREST API を双方向データベーステーブルとして、XML/JSON ファイル（ローカルファイル、一般的なクラウドサービスに保存されているファイル、FTP サーバー）を読み取り専用のビューとしてモデル化します。HTTP Basic、Digest、NTLM、OAuth、FTP などの主要な認証スキームがサポートされています。認証についての詳細は、ヘルプドキュメントの「はじめに」を参照してください。

    URI を設定し、認証値を指定したら、Format を"XML" または"JSON" に設定して、データ表現をデータ構造により厳密に一致させるようにDataModel を設定します。

    DataModel プロパティは、データをどのようにテーブルに表現するかを制御するプロパティで、以下の基本的な設定を切り替えます。

    • Document （デフォルト）：REST データのトップレベルのドキュメントビューをモデル化します。データプロバイダーはネストされたエレメントをデータの集計として返します。
    • FlattenedDocuments：ネストされたドキュメントとその親を単一テーブルとして暗黙的に結合します。
    • Relational：階層データから個々の関連テーブルを返します。テーブルには、親ドキュメントにリンクする主キーと外部キーが含まれます。

    リレーショナル表現の構成について詳しくは、「REST データのモデル化」を参照してください。次の例で使用されているサンプルデータもあります。データには、人、所有している車、およびそれらの車で行われたさまざまなメンテナンスサービスのエントリが含まれています。The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

  4. 接続を設定したら、 Save & Test をクリックして接続が成功したことを確認します。

API Server のユーザー設定

次に、API Server を通じてREST のデータにアクセスするユーザーを作成します。Users ページでユーザーを追加・設定できます。以下の手順でユーザーを設定・作成します。

  1. Users ページで、 Add User をクリックして Add User ダイアログを開きます。
  2. 次に、Role、Username、Privileges プロパティを設定し、Add User をクリックします。
  3. その後、ユーザーの Authtoken が生成されます。各ユーザーの Authtoken やその他の情報は Users ページで確認できます。

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

ユーザーを作成したら、REST テーブル用の API エンドポイントを作成します。

  1. まず、API ページに移動し、 Add Table をクリックします。
  2. アクセスしたい接続を選択し、Next をクリックします。
  3. 接続を選択した状態で、各テーブルを選択し、Confirm をクリックしてエンドポイントを作成します。

OData URL の取得

REST のデータへの接続を設定し、ユーザーを作成し、API Server にリソースを追加したので、これらのリソース用の OData プロトコルに基づいた簡単にアクセスできる REST API が利用可能になりました。API Server の API ページから、API の API エンドポイントを表示およびコピーできます。

REST のデータ を外部データソースとして接続

以下の手順に従って、API Server が生成するフィードに接続します。

  1. Salesforce にログインし、設定 -> 開発 -> 外部データソース をクリックします。
  2. 「新規外部データソース」をクリックします。
  3. 以下のプロパティの値を入力します：
    • 外部データソース：リストビューやレポートで使用するラベルを入力します。
    • 名前：一意の識別子を入力します。
    • 種類：「Salesforce Connect: OData 4.0」オプションを選択します。

    • URL：API Server の OData エンドポイントへの URL を入力します。URL の形式は https://your-server:your-port/api.rsc です。

      注意：プレーンテキストはテスト専用です。本番環境では TLS を使用してください。

  4. 「書き込み可能外部オブジェクト」オプションを選択します。

  5. 「形式」メニューで JSON を選択します。

  6. 「認証」セクションで、以下のプロパティを設定します：
    • ID 種類：組織のすべてのメンバーが同じ資格情報を使用して API Server にアクセスする場合は、「指定プリンシパル」を選択します。組織のメンバーが独自の資格情報で接続する場合は、「ユーザーごと」を選択します。
    • 認証プロトコル：Basic 認証を使用する場合は「パスワード認証」を選択します。
    • 証明書：Salesforce からサーバーへの通信を暗号化・認証するために使用する証明書を入力または参照します。
    • ユーザー名：API Server のユーザー名を入力します。
    • パスワード：ユーザーの Authtoken を入力します。

REST オブジェクトの同期

外部データソースを作成したら、以下の手順に従って、データソースの変更を反映する REST 外部オブジェクトを作成します。REST 外部オブジェクトの定義を REST テーブルの定義と同期します。

  1. 作成した外部データソースのリンクをクリックします。
  2. 「検証して同期」をクリックします。
  3. 外部オブジェクトとして操作する REST テーブルを選択します。

REST のデータ を Salesforce オブジェクトとしてアクセス

REST のデータ を外部データソースとして追加し、REST テーブルを REST 外部オブジェクトと同期したら、標準の Salesforce オブジェクトと同様に外部オブジェクトを使用できます。

  • フィルターリストビューを持つ新しいタブを作成：

  • 標準 Salesforce オブジェクトと一緒に REST 外部オブジェクトの関連リストを表示：

  • Salesforce ダッシュボードのタブから REST オブジェクトの作成、読み取り、更新、削除：

トラブルシューティング

一般的な接続の問題を避けるために、以下のチェックリストを使用できます：

  • サーバーにパブリックアクセス可能な IP アドレスがあることを確認してください。これに関連して、OS レイヤーで、ファイアウォールが API Server が実行されているポートを開いていることを確認する必要があります。アプリケーションレイヤーでは、管理コンソールの Settings -> Security タブで信頼できる IP アドレスを追加していることを確認してください。
  • 商用の信頼できる CA からの SSL 証明書で保護された接続を使用していることを確認してください。Salesforce は現在、自己署名証明書や内部 CA を受け入れていません。

  • API Server をホストしているサーバーが TLS 1.1 以上を使用していることを確認してください。.NET API Server を使用している場合は、.NET API Server の組み込みサーバーを使用することで実現できます。

    IIS を使用している場合、TLS 1.1 および 1.2 はサポートされていますが、デフォルトでは有効になっていません。これらのプロトコルを有効にするには、MSDN のハウツーと Microsoft 技術リファレンスを参照してください。

    Java エディションを使用している場合、TLS 1.2 は Java 8 ではデフォルトで有効ですが、Java 6 または 7 では有効ではありません。これらの以前のバージョンを使用している場合は、この Oracle ハウツーを参照してください。

はじめる準備はできましたか？

詳細はこちら、または無料トライアルにお申し込みください：

CData API Server お問い合わせ

この記事の内容

関連記事