Salesforce Connect で DocuSign 外部オブジェクトを編集・検索(API Server)
CData API Server を使用すると、Salesforce コンソールや Salesforce1 モバイルアプリなどのクラウドベースのアプリケーションからDocuSign のデータにアクセスできます。この記事では、API Server と Salesforce Connect を使用して、標準の Salesforce オブジェクトと一緒に DocuSign 外部オブジェクトにアクセスする方法を説明します。
API Server のセットアップ
まだインストールしていない場合は、CData API Server をダウンロードしてください。API Server をインストールしたら、以下の手順に従ってセキュアな DocuSign OData サービスの作成を開始します。
DocuSign への接続
Salesforce Connect からDocuSign のデータを操作するには、まず DocuSign への接続を作成・設定します。以下の手順で API Server を設定してDocuSign のデータに接続します。
- まず、Connections ページに移動します。
-
Add Connection をクリックし、DocuSign 接続を検索して選択します。
-
DocuSign に接続するために必要な認証プロパティを入力します。
DocuSign への接続には以下の接続プロパティを設定します:
- UseSandbox: UseSandbox は現在のユーザーアカウントがサンドボックスかそうでないかを示します。デフォルトはfalse です。サンドボックスアカウントがある場合はTrue に設定します。
- AccountId (optional): 認証が成功すると自動的に設定されます。 または、複数のAccount Id にアクセスできる場合は、接続文字列で手動で設定できます。アカウントId を取得するには、UserInfo ビューをクエリします。
DocuSign への認証
DocuSign はOAuth 認証標準を利用しています。OAuth を使って認証するには、アプリケーションを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得しなければなりません。認証方法については、ヘルプドキュメントの「OAuth 認証の使用」を参照してください。
- 接続を設定したら、 Save & Test をクリックして接続が成功したことを確認します。
API Server のユーザー設定
次に、API Server を通じてDocuSign のデータにアクセスするユーザーを作成します。Users ページでユーザーを追加・設定できます。以下の手順でユーザーを設定・作成します。
- Users ページで、 Add User をクリックして Add User ダイアログを開きます。
-
次に、Role、Username、Privileges プロパティを設定し、Add User をクリックします。
-
その後、ユーザーの Authtoken が生成されます。各ユーザーの Authtoken やその他の情報は Users ページで確認できます。
DocuSign 用の API エンドポイントの作成
ユーザーを作成したら、DocuSign テーブル用の API エンドポイントを作成します。
-
まず、API ページに移動し、 Add Table をクリックします。
-
アクセスしたい接続を選択し、Next をクリックします。
-
接続を選択した状態で、各テーブルを選択し、Confirm をクリックしてエンドポイントを作成します。
OData URL の取得
DocuSign のデータへの接続を設定し、ユーザーを作成し、API Server にリソースを追加したので、これらのリソース用の OData プロトコルに基づいた簡単にアクセスできる REST API が利用可能になりました。API Server の API ページから、API の API エンドポイントを表示およびコピーできます。
DocuSign のデータ を外部データソースとして接続
以下の手順に従って、API Server が生成するフィードに接続します。
- Salesforce にログインし、設定 -> 開発 -> 外部データソース をクリックします。
- 「新規外部データソース」をクリックします。
- 以下のプロパティの値を入力します:
- 外部データソース:リストビューやレポートで使用するラベルを入力します。
- 名前:一意の識別子を入力します。
- 種類:「Salesforce Connect: OData 4.0」オプションを選択します。
URL:API Server の OData エンドポイントへの URL を入力します。URL の形式は https://your-server:your-port/api.rsc です。
注意:プレーンテキストはテスト専用です。本番環境では TLS を使用してください。
- 「書き込み可能外部オブジェクト」オプションを選択します。
「形式」メニューで JSON を選択します。
- 「認証」セクションで、以下のプロパティを設定します:
- ID 種類:組織のすべてのメンバーが同じ資格情報を使用して API Server にアクセスする場合は、「指定プリンシパル」を選択します。組織のメンバーが独自の資格情報で接続する場合は、「ユーザーごと」を選択します。
- 認証プロトコル:Basic 認証を使用する場合は「パスワード認証」を選択します。
- 証明書:Salesforce からサーバーへの通信を暗号化・認証するために使用する証明書を入力または参照します。
- ユーザー名:API Server のユーザー名を入力します。
- パスワード:ユーザーの Authtoken を入力します。
DocuSign オブジェクトの同期
外部データソースを作成したら、以下の手順に従って、データソースの変更を反映する DocuSign 外部オブジェクトを作成します。DocuSign 外部オブジェクトの定義を DocuSign テーブルの定義と同期します。
- 作成した外部データソースのリンクをクリックします。
- 「検証して同期」をクリックします。
- 外部オブジェクトとして操作する DocuSign テーブルを選択します。
DocuSign のデータ を Salesforce オブジェクトとしてアクセス
DocuSign のデータ を外部データソースとして追加し、DocuSign テーブルを DocuSign 外部オブジェクトと同期したら、標準の Salesforce オブジェクトと同様に外部オブジェクトを使用できます。
-
フィルターリストビューを持つ新しいタブを作成:
-
標準 Salesforce オブジェクトと一緒に DocuSign 外部オブジェクトの関連リストを表示:
-
Salesforce ダッシュボードのタブから DocuSign オブジェクトの作成、読み取り、更新、削除:
トラブルシューティング
一般的な接続の問題を避けるために、以下のチェックリストを使用できます:
- サーバーにパブリックアクセス可能な 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 ハウツーを参照してください。