OAuth 2.0移行ガイド
はじめに
この記事では、APIキーからOAuth 2.0に移行するために、CoupaでOAuthクライアントを設定するために完了する必要がある手順について説明します。
APIキーの無効化と移行は、Coupaコアプラットフォームへの顧客のインテグレーションにのみ影響し、Treasury、CSO、Supply Chain Design & Planningなどのアプリケーションには影響しません 。
仕組み
すべてのCoupaインスタンス(本番、テスト、開発、ステージなど)で次の手順を完了してください。
1. CoupaでAPIキーを確認する
- Coupaインスタンスにログインします。
- [設定]>[ APIキー]に移動します。
- すべてのキーを確認します。
2. OAuth Clientの作成とスコープの割り当て
- [設定]>[ Oauth2/OpenID接続クライアント](/oauth2/ clients)に移動します。
- [作成]を クリックし、[許可タイ プ]ドロップダウンで[クライアント資格情報]を選択します。
- フィールドに入力し、クライアントに必要な範囲(アクセス権限)を選択します。すべてのAPIエンドポイントと操作へのアクセスをクライアントに許可する場合は、そのクライアントにすべての範囲を追加する必要があります。
- クライアントを保存すると、識別子、シークレット、Oidc範囲などのクライア ント認証情報が取得されます。詳細については、
3.資格情報テスト(PostmanのようなHTTPクライアントを使用した接続テスト)
- ターミナル(LINK)を使用して、コマンドラインを使用してCurl POSTを実行します。
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "client_id=<CLIENT_ID>&grant_type=client_credentials&scope=<SPACE_SEPARATED_LIST_OF_SCOPES>&client_secret=<CLIENT_SECRET>" https://<INSTANCE_DOMAIN>/oauth2/token
- PostmanなどのHTTPクライアントまたは別のRESTクライアントを使用して、Coupa APIを使用するようにOAuth2/OIDCクライアント接続を設定します。
- [POST]を選 択します。
- URLを、上記でクライアントを定義したインスタンス名に設定します。 例:https://{your_instance_address}/oauth2/token
- Content-Typeのヘッダーキー値を設定=
application/x-www-form-urlencoded
- POSTの本文に次の値を設定します。
-
[送信]をクリックします。POST応答には、定義さ
access_token
れた範囲内で次の24時間(expires_in
86,399秒)のAPI呼び出しを承認するために生成されたが含まれます。
-
応答の本
access_token
体から値をコピーし、このクライアント接続に定義した範囲内で、Coupa API呼び出しの承認ヘッダーでトークン値として使用しま す。 Coupa API Coupaは次の点に注意してください。 -
新しいタブを作成して、GET、POST、PUTなどのAPI呼び出しを行い、リクエストビルダーの権限付与部分で「タイプ」=(TYPE)を定義しま す
OAuth 2.0
。 -
[ヘッダー] に移 動し、[受け入れる]キーフィー
application/xml
ルドapplication/json
にまたはの値 を入力します 。コールと使用しようとしているインターフェイスに従って、他のリクエストパラメータを設定および定義する必要があります。この例では、請求書APIへのGET APIコールを確認できます。
-
[送信]をクリックします。[承認]ヘ
access_token
ッダーにそ れを 設定すると、その接続に定義したクライアント範囲にGET、PUT、またはPOSTコールを行うことができます。
4.トークン作成用のミドルウェアスクリプト/フローを構築し、20時間ごとに更新
ミドルウェアによって設定が異なる場合があります。ただし、Coupa APIキーを使用するすべてのインテグレーションがOAuthトークンを使用するように更新されていることを確認することが重要です。このトークンの生成と更新には、20時間ごとに確実に更新されるように、新しいスクリプト/フローを作成する必要がある場合があります。ミドルウェアのほとんどのアダプターは、設定完了後にトークンを自動的に更新します。
クライアント内の範囲を変更すると、トークン生成リクエストで渡されるため、トークン生成スクリプト/アダプタに影響します。
OAuth2.0アダプターの設定方法に関する各種ミドルウェアについては、以下のドキュメントのリンクを参照してください。
5.インテグレーションを更新して、スクリプトによって生成された新しいトークンを使用する
既存のすべてのインテグレーションでは、OAuth接続を採用し、新しいスクリプト/フローによって生成されたトークンを使用する必要があります。これは、たとえば、マスターデータのインテグレーションが最初に移行され、その後トランザクションデータのインテグレーションが後の段階で移行されるといったフェーズで実行できます。
6.古いAPIキーを無効にする
移行処理の一環として、OAuth2.0への移行後に既存のAPIキーが使用されないように無効にしてください。
- [設定]>[ APIキー]に移動します。
- 古いAPIキーを編集します。
- [APIキー の取り消し]をクリックします。
7. Coupa Success Portalで利用可能なリソースと情報
Coupaウェビナー
- 2022年3月25日:OAuth(API)に移行
以下のリソースを使用して詳細を確認することもできます。
このページに表示されている一部、または全ての内容は、機械翻訳によるものです。ご了承ください。