例 C: OAuth 2.0 クライアント資格情報認証を使用して API 仕様からコネクタを構築する

「コネクタ ビルダー」の USPS API の例に従って、OAuth 2.0 クライアント資格情報認証を使用して API 仕様からコネクタを構築します。

次の例では、OAuth 2.0 クライアント資格情報認証を使用して、既存の API ドキュメントから USPS 用のコネクタを構築します。

API ドキュメントからのインポート

このアプローチでは、API リファレンスに含まれる数のリソースを簡単にインポートできます。 コネクタ ビルダーでは、既存の API ドキュメントを JSON または YAML 形式で、あるいは Swagger や Postman を使用してアップロードできます。

次の例では、USPS Address Validation/Normalization API用のコネクタを構築しています。 例 A と B とは異なり、ここでは次のことを行います。

• USPSのWebサイトからAPIリファレンスをダウンロードします。
• OAuth 2.0 クライアント資格情報認証を使用します。

API リファレンスをダウンロード

1. USPS開発者ポータル(https://developer.usps.com/)にサインアップし、APIカタログに移動します。
2. コネクタを構築する API リファレンスをダウンロードします。たとえば、 アドレス 3.0 です。

API リファレンスをコネクタ ビルダーにインポートする

1. API リファレンスをコネクタ ビルダーにアップロードします。

   

2. [ 作成] を選択すると、アップロードした定義で利用可能なすべてのリソース (GET/addresses、GET/city-state、GET/zipcode) が表示されます。

   

認証を構成する

次に、認証を構成する必要があります。OAuth 2.0 クライアント資格情報を使用するには、 USPS 開発者ポータルで OAuth 2.0 アプリケーションを作成する必要があります。詳しくは、『 概要 ガイド』をご覧ください。

1. USPS 開発者ポータルで、 [アプリ ] に移動し、 [ アプリの追加] を選択します。

2. アプリケーションを構成します。作成したら、 コンシューマー キー と コンシューマー シークレットの 資格情報をコピーします。これらは、[クライアント ID] フィールドと [クライアント シークレット] フィールドに対応しています。

   

3. コネクタ ビルダーに戻り、[ 認証の種類 ] を [OAuth 2.0 クライアント資格情報] に設定します。

4. 次の資格情報を設定します。

   1. クライアント ID:<your Consumer Key>
   2. クライアント シークレット:<your Consumer Secret>
   3. 範囲: アドレス
   4. トークン URL: https://api.usps.com/oauth2/v3/token

5. コネクタをテストします。[ 要求を送信 ] を選択して、作成した API リソースをテストし、以下のように入力パラメーターを指定します。