概述介绍
高仙开放平台向开发者提供机器人全链路技术能力开放，满足多场景应用。立足于终端场景需求，助力开发者实现更多可能。客户可以根据自身需要获取机器人管理的必要信息，完成自己的资产管理，打造属于客户自己的数据看板。
API 对客户开放。使用本服务之前，需要先完成账号与凭证申请。
一、账号与凭证申请
账号与凭证的申请方式在 V1、V2、V3 之间完全一致，统一由开放平台 V3 的快速开始维护，本文不再重复步骤。请按 OpenAPI V3 快速开始 依次完成：
- 成为开发者：邀请开发者、激活账号，或为已有账号补充开发者角色。
- 创建 AccessKey：创建后同时获得
AccessKeyID、AccessKeySecret、ClientID和ClientSecret四项凭证。 - 获取访问令牌：使用上述凭证换取
access_token，再以 Bearer 方式调用业务接口。
应用管理已停止使用
原「应用管理」不再用于创建应用。新建 AccessKey 时系统会自动生成应用信息（ClientID 与 ClientSecret），无需再单独创建应用。存量应用仍可在该页面查看历史数据。
区域登录域名
各区域使用不同的登录域名，请按实际部署区域访问：
| 区域 | 登录地址 |
|---|---|
| 国内 | https://signin.gs-robot.com/ |
| 欧洲 | https://signin.eu.gausium-robot.com/ |
| 美国 | https://signin.us.gausium-robot.com/ |
二、API 接口介绍
以下为 V1/V2 接口清单。V3 接口使用 /openapi/v3/ 前缀与统一响应结构，请直接查阅 V3 接口文档。
| 服务 | 接口 | 接口说明 |
|---|---|---|
| OpenapiOauthService | GetOAuthToken | 获取 token |
| OpenapiOauthService | RefreshOAuthToken | 刷新 token |
| RobotInformationService | ListRobots | 分页获取机器人列表 |
| RobotInformationService | ListRobotStatusReports | 根据时间范围查询机器人状态报告，包括在线时长等 |
| RobotInformationService | M->V1_GetRobotStatus | 获取 M 系列机器人实时状态 |
| RobotInformationService | M->V1_BatchGetRobotStatuses | 批量获取 M 系列机器人实时状态 |
| RobotInformationService | S->V2_GetSRobotStatus | 获取 S 系列机器人实时状态 |
| RobotInformationService | S->V2_BatchGetSRobotStatus | 批量获取 S 系列机器人实时状态 |
| RobotTaskService | S->GetSiteInfo | 获取站点相关的信息 |
| RobotTaskService | S->SubmitSiteTask | 对有站点服务进行机器人临时清洁任务下发 |
| RobotTaskService | S->SendTempTaskCommand | S 系列机器人无站点绑定地图的临时任务下发 |
| RobotTaskService | S->TriggerSiteTasks | 触发 S 系列机器人有站点任务图示 |
| RobotTaskService | M->TriggerRemoteTasks | 触发 M 系列机器人临时任务图示 |
| RobotCommandService | CreateRobotCommand | 对 M 系列机器人临时清洁任务下发 |
| RobotCommandService | GetRobotCommand | 对机器下发 CreateRobotCommand 后，通过 GetRobotCommand 获取当次的下发结果 |
| RobotCommandService | ListRobotCommands | 分页列出一个机器人的下发结果集合，只列出通过 openapi 接口发出的命令 |
| RobotMapService | M->V1_GetRobotMap | 获取 M 系列机器人地图 |
| RobotMapService | M->V1_UploadRobotMap | 1. 让 M 系列机器人上传对应的地图数据；2. 若软件版本支持地图版本化，改用 S->V2_UploadRobotMap |
| RobotMapService | M->V1_GetRobotRecord | 获取 M 系列机器人地图上传指令的执行结果 |
| RobotMapService | S->V2_GetRobotMap | 获取 S 系列机器人地图 |
| RobotMapService | S->V2_UploadRobotMap | 让 S 系列机器人上传对应的地图数据 |
| RobotCleaningDataService | M->V1_ListRobotTaskReports | 查询获取 M 系列机器人清洁任务报告详情 |
| RobotCleaningDataService | S->V2_ListRobotTaskReports | 查询获取 S 系列机器人清洁任务报告详情 |
| RobotCleaningDataService | GenerateRobotTaskReportPng | 获取任务报告的图片下载地址 |
| RobotCleaningDataService | ListRobotCleaningReports | 获取机器人清洁统计耗时报告 |
| RobotPushService | IncidentPush | 注册回调，支持实时接收事件推送 |
| RobotPushService | TaskReportPush | 注册回调，支持实时接收任务报告数据推送 |
三、开发指南
Postman 集合
接入开发者 API 服务后，可以使用我们提供的 Postman 集合快速掌握接口的调用方法和参数设置。集合内已预置请求示例与环境变量，可直接发送和调试请求，快速验证接口功能与响应。
常见问题
对接过程中遇到的账号、权限、机器人控制、任务报告、数据推送等问题，请查阅 常见问题。