授权方式

授权账号

猎户星空机器人 OpenAPI（下面简称 API）的授权账由猎户星空颁发；
授权账号包含 appid 和 secret，其中 appid 相当于账号的用户名，secret 相当于账号的密码；
下面所描述的授权，即为给一个授权账号赋予相应的权限；

授权维度

授权存在如下 3 个维度，API 同时受到这 3 个维度的授权限制，您需要根据自身情况来分别确认这 3 个维度的授权需求：
1. 数据维度授权
  - 数据维度授权类型分为：“代理商级授权” 和 “企业级授权”，详见数据维度授权；
2. IP 维度授权
  - IP 维度授权即为 IP 访问限制，详见 IP 维度授权；
3. 接口维度授权
  - 接口维度授权即为针对具体 API 的访问限制，详见接口维度授权；

数据维度授权

数据维度授权类型	可以访问的数据	如何选择
代理商级授权	可以访问被授权的代理商下所有企业的数据（企业信息、人员信息和机器人信息等）；一个授权账号可以授予多个代理商的数据访问权限；	您是代理商级客户，想使用同一个授权账号访问代理商下所有企业的数据
企业级授权	可以访问被授权的企业下的所有数据（人员信息和机器人信息等）；一个授权账号可以授予多个企业的数据访问权限；	您是企业级客户，希望使用同一个授权账号访问企业下的所有数据；您是代理商级客户，希望不同的企业下数据使用不同的授权账号访问（不希望用同一个授权账号访问代理商下所有企业数据）；

IP 维度授权

为什么需要 IP 维度授权
- 因 API 涉及到控制机器人，为保证安全，猎户星空需要验证调用 API 的服务端（调用端）外网出口 IP 地址；
猎户星空何时进行 IP 授权验证
- 猎户星空会在您获取访问凭证 access_token（调用获取访问凭证 access_token API）的时候进行 IP 授权验证；
- 除了上述获取访问凭证 access_token API 外，其他 API 猎户星空不会进行 IP 授权验证；
- 您在申请授权账号的时候需要告知您调用 API 的服务端（调用端）外网出口 IP 地址，猎户星空需要把此出口 IP 地址添加到白名单中之后您才能成功调用 API；
获取服务端的外网出口 IP 地址的方法
- 您在调用上述需要 IP 授权验证的 API 的时候，猎户星空会获取并验证您的（调用端的）外网出口 IP 地址，请您注意猎户星空需要添加到白名单的是您的外网出口 IP 地址（不是内网 IP，也不是入口 IP）；
- 请先咨询您的运维或者 IT 部门同事协助查询您的服务端外网出口 IP 地址；
- 您也可以在您调用上述需要 IP 授权验证的 API 的服务器上执行如下 cURL 命令来获取您的外网出口 IP 地址：
- ```
# 在您调用上述需要 IP 授权验证的 API 的服务器上执行
curl --location 'https://openapi.orionstar.com/v1/myip'
 
# 命令返回内容中 IP: 后面的就是您的外网出口 IP 地址，示例如下（示例中的 IP 地址为：11.22.33.44）：
IP: 11.22.33.44
```
- 下面列出常用的内网 IP 段，请确保您提供的外网出口 IP 不在如下 IP 段范围内（猎户星空需要您的外网出口 IP）：
  - 10.0.0.0 - 10.255.255.255
  - 172.16.0.0 - 172.31.255.255
  - 192.168.0.0 - 192.168.255.255

接口维度授权

接口维度授权类型分为如下 2 种：
- 默认授权
  - 默认授权的 API 是授权账号默认拥有的权限，无需额外申请即可调用；
  - 绝大部分的 API 均为默认授权，在具体的 API 中会描述是否是默认授权；
- 特殊授权
  - 特殊授权的 API 需要额外申请才能调用，在具体的 API 中会描述是否是特殊授权；
  - 如果需要调用特殊授权的 API 请联系猎户星空的售前技术支持申请；

Table of Contents

授权方式

授权账号

授权维度

数据维度授权

IP 维度授权

接口维度授权