添加集成唯一标识符

要与 Dotcom-Monitor 建立集成，您必须访问活跃的 Dotcom 监视器帐户，并创建 Web API 唯一标识符以用于身份验证请求：

  1. 登录到 Dotcom 监视器帐户。
  2. 在 Dotcom-Monitor 中，在配置集成下创建集成 UID > > 添加集成 > Web API。
  3. 将 IP 列入白名单，如 Wiki 的 如何将 Web API 访问的 IP 列入白名单 一文中所述。
  4. 可选：如果主帐户包含部门，并且您想要访问特定部门的 API 并发送请求，请在 “添加集成 “窗口中选择 “允许访问部门的数据“。
  5. 单击“创建集成”，并将Web API唯一标识符从集成 UID列表复制到剪贴板（在部门访问的情况下，可以访问部门数据）。

认证

请求网址

发布 https://api.dotcom-monitor.com/config_api_v1/login

当您通过”/登录”呼叫登录帐户时，新的客户端会话开始。 会话在预定的不活动长度后自动过期。 默认值为 1 分钟。 如果进行 API 调用，则不活动计时器将重置为零。
当会话过期时，将返回异常 HTTP 错误代码”401 – 未经授权”。 如果发生这种情况，您必须重新登录。

授权后，客户端由 Cookie 标识，因此请确保启用了 Cookie。

POST 内容

使用 Web API 唯一标识符作为UID参数值（配置 > 集成 > 添加集成 > Web API）。

{
"UID":"1423e214d153d123123"
}

部门 ID 访问

要通过 API 访问部门的数据，您需要创建一个 Web API（有权访问部门的数据） 集成。 将相应的 唯一标识符 用作 UID 参数，并结合身份验证请求中的 “Action”：1 名称/值对。

使用以下帖子内容示例：

{ 
"UID" : "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Action": 1
}

系统将使用可用部门 ID 的列表进行响应。 请参阅下面的示例 JSON。

{
    "Success": true,
    "Result": [
        {
            "Name": "my_org",
            "HasCompany": true,
            "HasDepartment": true,
            "Qantity": 2,
            "Accounts": [
                {
                    "Id": 15530,
                    "Name": "my_org",
                    "CompanyName": "my company",
                    "Email": "email@gmail.com",
                    "Owner": true,
                    "Department": false,
                    "New": false
                },
                {
                    "Id": 19357,
                    "Name": "Admin",
                    "CompanyName": "my company",
                    "Email": "email111@gmail.com",
                    "Owner": true,
                    "Department": true,
                    "New": false
                }
            ]
        }
    ]
}

复制要登录的部门的 ID，并将其与 UID 结合使用，以创建对该部门的身份验证请求。

使用下面提供的发布示例。

{ 
"UID" : "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
 "Id" : "XXXX"
}

其中 “UID”：“XXXXX….XXX“ 是您的Web API（有权访问部门数据） UID 和 ”Id“：”XXXX“ 是您的部门ID。

成功响应

{
"Success":true,
"Result":"OK"
}