帮助手册

Site24x7 API 入门

Site24x7 API 帮助您完成所有可在 Web 客户端执行的操作。API 需要使用 Authtoken 作为账户标识符。该 API 基于 REST 原则构建,确保 URL 可预测,使应用程序开发更加简便。API 遵循 HTTP 规则,可使用多种 HTTP 客户端与其交互。所有 Site24x7 API 均需要在请求头中包含 Authorization 字段进行身份验证,并使用 Authtoken 进行认证。您可以使用 Zoho Accounts API 以编程方式生成 Authtoken

通过程序调用 API:

创建 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 Authtoken(在您的 MSP 会话中操作)。
  2. 使用生成的 MSP Authtoken 向以下 URL 发送 HTTP GET API 请求
    https://www.site24x7.com/api/msp/customers/portals
  3. JSON 响应将包含所需 "portal_id" 的详细信息。

请求示例:

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,因为其中包含重要的身份信息。每个客户账户最多可拥有 10 个有效的 Authtoken。

删除 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,您必须先从 GET 请求(https://www.site24x7.com/api/msp/customers/portals)的响应中提取参数 "zaid" 的相关值。获取 "zaid" 值后,您可以在 API 请求中将其作为必填参数传入,或将其设置为 Cookie 名称为 "clientportal" 的 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" 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 的信息,请参阅我们的 API 文档

本文档对您有帮助吗?

您愿意帮助我们改进文档吗?请告诉我们哪些方面可以做得更好。


很抱歉本文档未能让您满意。我们希望了解可以从哪些方面改进您的体验。


感谢您抽出时间分享反馈。我们将利用您的反馈来改进在线帮助资源。

短链接已复制!