观远数据开放平台
返回最新版
返回最新版
当前版本V7.2.0
  1. 身份认证
  • 开发指南
    • Token 鉴权
    • 常见概念
    • 常见问题
  • 用户
    • 批量创建用户
      POST
    • 批量修改用户属性
      POST
    • 批量删除用户
      POST
    • 批量获取用户是否存在
      POST
    • 获取用户列表
      POST
    • 通过属性值获取用户列表
      POST
    • 修改用户状态
      POST
    • 通过loginId获取用户信息
      POST
  • 数据集
    • 使用parquet文件更新数据集
      GET
    • 获取数据集列表
      POST
    • 修改数据集路径
      POST
    • 数据集删除
      POST
    • 搜索数据集列表
      POST
    • 查询特定数据集的数据结构
      POST
    • 批量修改数据集更新方式
      POST
    • 获取指定数据集有使用权限的用户列表
      POST
    • 上传数据集
      POST
    • 获取数据集下载授权Token
      GET
    • 下载数据集数据
      POST
    • 获取数据集数据
      POST
    • 创建数据集
      POST
    • 更新数据集字段注释
      POST
    • 触发数据集读取数据文件并更新
      GET
    • 通过 TaskID 查询数据集更新结果
      GET
    • 修改数据集schema
      POST
    • 更新数据集
      POST
    • 修改数据集字段别名
      POST
    • 修改数据集名称
      POST
    • 数据集预览接口
      POST
    • 提供修改SQL模型结构接口
      POST
    • 获取数据集目录列表的接口，支持指定目录搜索
      POST
    • 批量查询数据集基本信息
      POST
    • 批量查询数据集权限信息
      POST
  • 仪表板
    • 获取页面列表
    • 根据页面名称关键词搜索页面
    • 获取指定页面有读权限的用户列表
    • 以树状结构获取页面列表
    • 以PDF或者图片模式导出仪表板
    • 获取仪表板导出文件
    • 获取页面基本信息
    • 获取页面信息
    • 仪表板智能洞察
  • 订阅预警
    • 下载自定义渠道推送文件
    • 启用/关闭订阅
    • 启用/关闭预警
  • 卡片
    • 获取卡片数据
    • 基于数据集创建卡片接口，提供生成随机ID的接口
  • 权限
    • 获取指定用户能访问的页面列表
    • 获取指定用户能访问的数据集列表
    • 修改指定用户与各个页面的访问及归属关系
    • 修改指定用户与各个数据集的访问及归属关系
    • 获取指定用户组能访问的页面列表
    • 获取指定用户组能访问的数据集列表
    • 修改指定用户组与各个页面的访问及归属关系
    • 修改指定用户组与各个数据集的访问及归属关系
    • 通用资源权限授权与解除
  • 资源操作
    • 将指定用户下辖有所有者权限的资源迁移至其他用户组或用户
    • 将指定用户组下有所有者权限的资源迁移至其他用户组或用户
    • 通用资源列表清单
  • 卡片导出
    • 卡片导出接口使用说明
    • public api 卡片导出
    • public api 任务状态轮询
    • public-api 卡片导出文件下载
  • session
    • session创建or更新
    • 查询数据集的session配置
  • 文件夹
    • 创建文件夹目录
    • 修改文件夹目录
    • 删除文件夹接口
    • 文件夹新增授权接口
    • 文件夹删除权限接口
    • 批量查询文件夹权限信息
  • 数据账户
    • 创建数据账户
  • 身份认证
    • 用户登录
      POST
    • 通过用户的loginId登录
      POST
    • 用户登出
      POST
  • 用户管理
    • 用户管理概述
    • 用户组
      • 批量创建用户组
      • 批量修改用户组
      • 删除指定用户组
      • 获取用户组列表
      • 添加单个用户组
    • 用户组成员
      • 将用户添加至用户组
      • 将用户从用户组删除
      • 获取指定用户组下直接挂载的用户列表
      • 获取指定用户直接所属的用户组列表
    • 角色
      • 查询某一用户的角色信息
      • 为某一用户增添自定义角色
      • 为某一用户解绑自定义角色
    • 用户关联账号
      • 关联账号配置介绍
      • 配置用户外部关联账号
      • 删除用户的关联账号
      • 查询用户的外部关联账号
  1. 身份认证

用户登录

POST
/public-api/sign-in
接口简介
通过个人账号与密码登录，获取合法的用户Token。

请求参数

Body 参数application/json

示例
{
    "domain": "demo",
    "loginId": "Id1",
    "password": "my_password_base64_encoded"
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/public-api/sign-in' \
--header 'Content-Type: application/json' \
--data-raw '{
    "domain": "demo",
    "loginId": "Id1",
    "password": "my_password_base64_encoded"
}'

返回响应

🟢200成功
application/json
Body

示例
{
    "result": "ok",
    "response": {
        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxLVNRZE5XVXRGajZ3ZE5jQjJBNmF5cU5yZDlueFdwL1RSSk5vYWJHTFh0UitkeUwwSVRVVjNLMXpMNnBYNFNiaU1oeXltWk1ZUlAzTUhhUWVXT2phdklidGtNNzJIRkN1UVZpM1Fid0x1aUQyc3A4clhlcWsyZTV5L1B6aU5Pdz09IiwiaXNzIjoiZ3VhbmRhdGEuY29tIiwiZXhwIjoxNzI4NDUyMzE5LCJpYXQiOjE3MjcyNDI3MTksImluaXRUaW1lIjoiMjAyNC0wOS0yNSAxMzozODozOS43MDYiLCJqdGkiOiIxOGFjYzgxZmU3NGQ5NzBkZGYzNmZmNzAwMTM3OGE0N2U4NjExZWNkMTk2ZGMzZjE3MjUxZmQ0MmNiOGQ2NmNjOGE0MGJmYzg1MDZlMjQzODAxODE1ODY2M2RmYWUzMTA1M2MzODFkMzkzNmZjMmYwOTA2ZjU0NGE1YzRmMmNiOWVlNDM0ZjFmNDk0ZDRmMWIwMjAxMjJhMmM2ZDQzZGQwYjViZGE0YTc4YmY5MmI0Y2Y1NzM5ZmI4ZjQ4ZjE1MTY4OWZlOTBiMWFhMTExYjI5ZWJhYzc2ZDU4OTBlZWQwOGVhYTE2ZDI4NjEwYWNjMDM1MzhlNWJmNjA2Y2JjOGY3IiwicHdkVmVyc2lvbiI6MS4wfQ._XUe3kHbLVac8EcrJq8EtrcnMdxdwkkZvHkd523phI4",
        "expireAt": "2024-09-26 13:38:39.707"
    }
}
🔴500密码错误
修改于 2025-02-28 05:42:43
上一页
创建数据账户
下一页
通过用户的loginId登录
Built with