Site24x7 API 入门

Site24x7 API 帮助您实现可以在我们的 Web 客户端上执行的所有操作。API 需要 Authtoken 作为帐户标识符。此 API 使用 REST 原则构建，可确保可预测的 URL，从而使编写应用程序变得容易。API 遵循 HTTP 规则，可以使用各种 HTTP 客户端与 API 交互。所有 Site24x7 API 都需要 Authorization 请求标头进行身份验证，并使用 authtoken 进行身份验证。您可以使用 Zoho Accounts API 以编程方式生成授权令牌。

以编程方式使用 API：

创建授权令牌
删除授权令牌
如何将 Authtoken 用于 API

创建授权令牌

向以下 URL 提交 HTTP POST 请求。

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

以下是要在 URL 中传递的强制区分大小写参数。

范围	描述
门户网站	<portal_id>*
电子邮件	<电子邮件>
密码	<密码>
客户端门户	真的
范围	站点 24x7/站点 24x7api
描述	api
授予类型	密码

* 要获取您的portal_id，请按照下列步骤操作：

生成MSP authtoken（当您在 MSP 会话中时）。
将生成的 MSP authtoken 提交到以下 URL的HTTP GET API 请求：

https://www.site24x7.com/api/msp/customers/portals
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，只需向以下 URL 提交 HTTP POST 请求。

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

以下是要在 URL 中传递的强制区分大小写参数。

参数示例	描述
门户网站	<传送门>
授权令牌	<授权令牌>

请求示例:

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 来发送请求。

如何将 Authtoken 用于 API

要成功使用 API 的 authtoken，您必须首先提取从 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 文档。