API アクセスのセットアップ

DevKit は、Studio 6 および Mule 3 とのみ互換性があります。Mule 4 Connector を作成するには、 「Mule SDK」ドキュメント​を参照してください。

コネクタプロジェクトを開始する前に、接続先の API について調べます。対象のプロバイダが提供する API ドキュメントを収集して参照するだけでなく、テストできるようにインスタンスへのアクセス権を作成します。

コネクタをローカルエンタープライズアプリケーションまたはその他の Web サービスにビルドするために必要な Sandbox アクセス権、サポートするコードおよびドキュメント、その他のサポートは通常、ローカル管理者またはアプリケーションベンダーによって提供されます。SaaS アプリケーションには通常、API にアクセスするためのセルフサービスプロセスが用意されていて、これはサービスごとに異なります。

このドキュメントでは、実行する必要があると考えられる一般的な準備ステップの概要を示し、2 つのケース、「​Salesforce の例​」と「​Twitter の例​」を取り上げます。

前提条件

このドキュメントでは、読者が API、Web サービス、またはその他のリソースに精通していて、対象の API のドキュメントまたはクライアントライブラリが公開されていることを前提としています。

クラウド API

クラウド API は Software as a Service (SaaS) または Web サービスとも呼ばれ、アプリケーションプロバイダと協力してテスト/開発者アカウント、Sandbox 環境、API アクセス権限をセットアップする必要がある場合があります。一般的に、こうしたタスクを行うにはいくつかのステップを実行する必要があります。各ケースについての正しい手順については、API プロバイダのドキュメントを確認する必要があります。参考として、Salesforce と Twitter の 2 つの例を以下で示しています。

以下の例は、このガイドの執筆時点では正しい情報ですが、API オーナーが後から手順を変更する可能性があることに留意してください。

Salesforce の例

  1. Salesforce アカウントに登録します​。確認メールを受信するためにメールアドレスを指定する必要があります。

  2. 登録フォームへの入力が完了したら、確認メールを開いて記載されたリンクをクリックし、パスワードを設定して Salesforce Developer Edition にログインできるようにします。

  3. リモートアプリケーションで Salesforce にログインできるようにするには、次のステップを実行して Salesforce でセキュリティトークンをリセットする必要があります。

    1. Salesforce UI から、右上の ​[あなたの名前]​ > ​[私の設定]​ を選択します。

    2. 左サイドバーで ​[私の個人情報]​ を展開し、​[私のセキュリティトークンのリセット]​ を選択します。

      reset_token
    3. [セキュリティトークンのリセット]​ ページで、​[セキュリティトークンのリセット]​ ボタンをクリックします。Salesforce から新しいセキュリティトークンがメールで届きます。

  4. セキュリティトークン​、​ユーザ名​、​パスワード​を記録します。これらの項目が下の例を実行するために必要になります。

Twitter の例

Twitter は、コネクタからアクセスする比較的シンプルな API の好例です。これは、多くの Web アプリケーションまたはサービスが類似モデルに従っているためです。

  1. Twitter API にアクセスするには、最初に Twitter アカウントを取得する​必要があります。

  2. 作成したアカウントから Twitter API にアクセスするには、Twitter の 開発者ポータル​で空の Twitter アプリケーションを作成する必要があります。

  3. Twitter Connector をテストするには、Twitter から次の要素を取得します。

    • Access key (アクセスキー)

    • Access secret (アクセスシークレット)

    • Consumer key (コンシューマキー)

    • Consumer secret (コンシューマシークレット)

SOAP ベースの API

SOAP ベースの API では、API プロバイダから WSDL ファイルを取得する必要があります。さらに、SOAP ベースのサービスでは永続的なセッション、各メッセージに含まれたセキュリティヘッダー、セキュリティトークンなど、認証スキームが異なっている場合があります。コネクタを実装するときに、こうしたそれぞれのスキームに個別に注意する必要があります。

Java ライブラリの使用

使用が可能な場合、サービスにアクセスするために既存の Java ライブラリをダウンロードできます。これは、アプリケーションにアクセスするための唯一の手段であるクライアントライブラリの場合もあれば、アプリケーションの公開された Web サービスのラッパーである場合もあります。ライブラリを使用するには、プロジェクトに Maven 連動関係として含めます。

Maven を使用したアプリケーションのビルドについての詳細は、公式 Maven ドキュメントの​ 「Introduction to the Maven Build Cycle (Maven ビルドサイクルの概要)」​を参照してください。

関連情報

次へ:​ ​「Anypoint Connector プロジェクトの作成」​に進み、コネクタの開発を開始します。