diff --git a/suites-help/系统使用手册/快速入门.md b/suites-help/系统使用手册/快速入门.md index a6c060f..b681701 100644 --- a/suites-help/系统使用手册/快速入门.md +++ b/suites-help/系统使用手册/快速入门.md @@ -1,33 +1,56 @@ # 快速入门 -## 第一步:打开套件市场 +## 第一步:获取 API Key -访问 [https://suites.mercator.cn](https://suites.mercator.cn)。 +访问 https://auth.mercator.cn,创建 API Key(`mk_` 开头)。 -市场首页展示平台简介。点击顶部导航栏的「套件」进入套件列表。 +API Key 是 Agent 与平台交互的唯一凭证。 ## 第二步:浏览套件 -在套件列表页,你可以: +```bash +# 列出所有套件 +curl -s https://suites.mercator.cn/api/v1/suites -- **搜索**:按关键词搜索套件名称和描述 -- **浏览**:滚动查看所有已发布的套件 -- **查看详情**:点击套件名称查看参数说明、输入输出 +# 搜索套件 +curl -s "https://suites.mercator.cn/api/v1/suites/search?q=缓冲区" -## 第三步:登录 +# 查看套件详情 +curl -s https://suites.mercator.cn/api/v1/suites/{suite_id} +``` -点击右上角「登录」按钮,跳转到认证中心登录。 -支持账号密码登录或企业微信扫码登录。 +## 第三步:选择套件 -## 第四步:执行套件 +从列表中筛选符合需求的套件,记录它的 `suite_id` 和参数说明。 -1. 进入套件详情页 -2. 填写参数(输入文件路径、数值等) -3. 点击执行 -4. 等待执行完成 -5. 查看结果 +## 第四步:提交执行 + +```bash +curl -s -X POST https://suites.mercator.cn/api/v1/suites/{suite_id}/execute \ + -H "Authorization: Bearer ***" \ + -H "Content-Type: application/json" \ + -d '{"buffer_distance": 0.5}' +``` + +返回结果中包含 `task_id`,用这个 ID 查询执行状态。 + +## 第五步:查询状态 + +```bash +curl -s https://suites.mercator.cn/api/v1/task/{task_id}/status +``` + +状态:`pending` → `running` → `completed` / `failed` + +## 第六步:获取结果 + +任务完成后,从返回结果中读取输出数据。 ## 前置条件 -- 需要 **API Key** 或账号密码登录 -- 执行任务需要在本地安装 **GIS Actions**(见本地部署文档) +- **API Key**(必须) +- **GIS Actions** 在本地运行(用于实际执行任务) + +## 数据安全 + +**数据永不离开本地。** 你的文件始终在你的机器上处理。