APIゲートウェイのプリリクエスト設定を使用したOAuth認証の処理 – OptiSigns

この記事では、APIゲートウェイを使用してAPIに接続するためのOAuth 2.0アクセストークンを取得するプリリクエストの設定方法について説明します。

OptiSigns APIゲートウェイでは、プリリクエストを介したOAuth認証が可能です。これにより、ユーザーはOAuth認証または同様の認証を必要とするAPIを利用できるようになります。

開始するには、APIリクエストを設定する必要があります。アカウント名 → その他 → データソースをクリックします：

how to navigate to datasource

そこから、リクエストを追加をクリックします。

datasources add request button

GET リクエストを作成し、APIエンドポイントを入力してから、プリリクエスト：をクリックします

optisigns api request form pre-request

プリリクエストフィールドに、以下のコードを入力します：

const body = {
  "grant_type": "client_credentials",
  "client_id": "<CLIENT_ID>",
  "client_secret": "<CLIENT_SECRET>"

};
const params = Object.keys(body || {}).map((key) => {
        return key + '=' + body[key];
      }).join('&');

const {data, headers} = await os.postRequest("<OAUTH_AUTHENTICATION_URL>", params,{headers: {'content-type': 'application/x-www-form-urlencoded'}});
const token = 'Bearer' + data.access_token;
os.context.set("request.headers.authorization", token);

注意事項：

"grant_type": "client_credentials"を使用してください。"client_credentials"は、ユーザーの操作なしでサーバー側の統合を行うためのOAuthのグラントタイプです。
<CLIENT_ID>と<CLIENT_SECRET>は、アクセスされるAPIのユーザーコードを指します。これらはユーザーが提供する必要があります。
<OAUTH_AUTHENTICATION_URL>は、アクセストークンが取得されるURLを指します。このURLはユーザーが提供する必要があります。

次にヘッダーを設定します：

properly configured API header

これらと他の必須フィールドがすべて入力されたら、プリリクエストが正しく設定されています。テストを実行をクリックすると、200 OKレスポンスが返されるはずです。

successful api request

成功したら、保存をクリックしてAPIリクエストを完了します。

以上です！

OptiSignsについてご質問、ご不明な点、またはフィードバックがございましたら、サポートチーム（support@optisigns.com）までお気軽にお問い合わせください。