ヘルプ MSP MSP APIの利用方法

MSP APIの利用方法

Site24x7のAPIを使用したWebクライアントでの操作が可能となっています。
APIではauthTokenを、アカウントの識別子として利用します。このAPIは、REST原則に基づき作成されているため、URLの挙動は予測可能となっており、アプリケーションの記述が容易です。
APIはHTTPのルールにしたがっており、幅広いHTTPクライアントでAPIと通信できます。
Site24x7のAPIはすべて認証に認証要求ヘッダーを必須とし、 authTokenで認証しています。

ZohoアカウントAPIでは、authTokenのプログラムによる作成が可能です。

目次

authTokenの作成

下記URLからHTTP post要求を送信してください。

https://accounts.zohoportal.com/accounts/client/authtoken

下記のパラメーターがURLへ渡されます。パラメーターは必須で、大文字と小文字を区別します。

パラメーター 記述
 portal  <portal_id>*
email  <email>
 password  <password>
 client_portal  true
 scopes  Site24x7/site24x7api
 desc  api

 grant_type 

 password

次の手順で、portal_idを取得してください。

  1. MSPセッションの最中に、MSP authtokenを作成する。
  2. HTTP get API要求にMSP authTokenを付与して送信します。
    authTokenは次のURLで取得します。
    https://www.site24x7.com/api/msp_portals
  3. 必要な「portal_id」が、JSON応答に含まれています。
要求サンプル:
curl
-X POST
-H "Cache-Control: no-cache" "https://accounts.zohoportal.com/accounts/client/authtoken?portal=12353635607&email=accountcontact@zohocorp.com&password=11411111&client_portal=true&scopes
=Site24x7/site24x7api&desc=api&grant_type=password"
応答サンプル:
{"t":"json","data":{"token":"12353635607.13213743991.ce2af7cfdf47e3ef6262c20f1c06487ac2fbf210b4c34ef3d1f11c671"}}
authTokenには貴社特定にかかわる重要情報がありますので、不特定多数に知られないようにしてください。
顧客ごとに作成できるauthTokenの上限は、10です。

authTokenの削除

既存のauthtokenを削除するには、下記URLからHTTP post要求を送信してください。

https://accounts.zohoportal.com/accounts/client/authtoken/delete

下記のパラメーターがURLへ渡されます。パラメーターは必須で、大文字と小文字を区別します。

パラメーター 記述
 portal  <portalid>
 authtoken  <authtoken>
要求サンプル:
curl
-X POST
-H "Cache-Control: no-cache" "https://accounts.zohoportal.com/accounts/client/authtoken/delete?portal=12353635607&authtoken=12353635607.13213743991.ce2af7cfdf47e3ef6262c20f1c06487ac2fbf210b4c34ef3d1f11c671"
応答サンプル:
{"t":"json","data":{"response":true}}
authTokenは貴社から削除作業を行わない限り削除されません。複数の要求を送出する際、複数のauthTokenの作成は不要となっています。

API authTokenの使い方

authTokenをAPIで使うには、まずパラメーター 「zaid」の該当値を、ブラウザーcookie(clientportal)の保存情報から抽出しなくてはなりません。「zaid」の値を取得したら、この必須パラメーターをAPI要求に渡してください。

要求サンプル:
追加パラメーターを利用:
curl
-X GET
-H "Content-Type: application/json;charset=UTF-8"
-H "Accept: application/json; version=2.0"
-H "Authorization: Zoho-authtoken 12353635607.13213743991.ce2af7cfdf47e3ef6262c20f1c06487ac2fbf210b4c34ef3d1f11c671" https://www.site24x7.com/api/monitor_groups/status?zaid=j2db7FrteGyJWxa/JjpJlw==
cookieヘッダーを利用:
curl
-X GET
-H "Content-Type: application/json;charset=UTF-8"
-H "Accept: application/json; version=2.0"
-H "Authorization: Zoho-authtoken 12353635607.13213743991.ce2af7cfdf47e3ef6262c20f1c06487ac2fbf210b4c34ef3d1f11c671"
-H "Cookie: clientportal=j2db7FrteGyJWxa/JjpJlw=="
https://www.site24x7.com/api/monitor_groups/status
応答サンプル:
{"code":0,"message":"success","data":[{"group_name":"zohocorp.com","group_id":"20390000087595","monitors":3,"status":2,"error_monitors":1,"top_group":true}]}
Site24x7のAPIについては、Site24x7のAPIドキュメントを参照ください。