Site24x7リクエスト認証のためのPostman設定
OAuth 2.0認証でPostmanを設定するには、サーバーベースのクライアントのクライアントIDとクライアントシークレットが必要です。
OAuth 2.0認証のPostman設定手順は次のとおりです。
すでにクライアントIDとクライアントシークレットを所持している場合は、以下の設定方法のパート1はスキップして、パート2から始められます。
パート1：クライアントIDとクライアントシークレットの作成
このナレッジでは.comドメインをベースにし、記載しています。その他のデータセンターを利用している場合は、こちらのドキュメントを参照の上、エンドポイントを変更してください。
- https://api-console.zoho.com/にアクセスして、クライアントの追加をクリックします。
- クライアント名を入力し、タイプにサーバーベースアプリケーションを選択してください。残りの項目を入力したら、作成をクリックしてください。
- 例として、Homepage URLをhttps://www.site24x7.com/とすると、Authorized Redirect URIは https://www.site24x7.com/app/OAuth2CallBackになります。
クライアントIDとクライアントシークレットは別々に生成されます。この設定は必須となります。
クライアントIDとクライアントシークレットは誰にも教えないでください。
パート2；Postman設定
クライアントIDとクライアントシークレットを生成したら、次の操作を行います。
- Postmanを開き、新規リクエストを作成します。
- 左側のAuthorizationをクリックし、ドロップダウンのTypeにOAuth 2.0を選択します。
メモ：認証データは、リクエストURLではなく、リクエストヘッダーに追加されます。該当のドロップダウンからこれは変更できます。 - アクセストークンを所持している場合は、リクエストの認証にそれを使用できます。Access Tokenのテキストボックスに https://accounts.zoho.com/oauth/v2/tokenを入力します。このOAuth設定でPostmanを用いてリクエストを送信できるようになります。
アクセストークンを持っていない場合は、次の手順を行ってください。
- Get New Access Token（アクセストークン入力テキストボックスの下）をクリックします。トークン名と、前の設定で作成したクライアントIDとクライアントシークレットを入力します。Request Tokenをクリックします。
メモ：Callback URLはサーバーベースアプリケーションに対応するAuthorized Redirect URLを指定する必要があります。Scopeは呼び出すAPIによって異なります（例：Site24x7.Admin.Create、Site24x7.Admin.Readなど）
・Callback URL： https://www.site24x7.com/app/OAuth2CallBack
・Auth URL：https://accounts.zoho.com/oauth/v2/auth
・Access Token URL：https://accounts.zoho.com/oauth/v2/token - Acceptをクリックして、表示されている情報へのアクセスを承諾します。
メモ：エラー"ERROR_invalid_redirect_uri"が表示された場合は、サーバーベースアプリケーションのクライアントタイプの作成中に、Callback URLが、Authorized Redirect URLの中に1つでもあるかを確認してください。（パート1参照） - Use Tokenをクリックして、トークンの使用を開始します。
- 上記の設定で、GETリクエストをサンプリングし、Sendをクリックして、新規アクセストークンを使用したリクエストを認証します。