衡石科技BI的API如何授权文档解析

news2024/9/22 7:32:01

授权说明​

授权模式​

使用凭证式(client credentials)授权模式。

授权模式流程说明​

第一步,A 应用在命令行向 B 发出请求。 第二步,B 网站验证通过以后,直接返回令牌。

授权模式结构说明​

接口说明​

获取access_token​

获取access_token。开发者需要缓存access_token,用于后续接口的调用。当access_token失效或过期时,需要重新获取。

请求URL​

http

GET /api/oauth2/server/tokens?grant_type=client_credentials&client_id=${CLIENT_ID}&client_secret=${CLIENT_SECRET} HTTP/1.1
Accept: application/json

1
2

URL 参数​
字段类型是否必须描述
grant_typeSTRING授权类型,固定值 :client_credentials。表示采用凭证式
client_idSTRING客户端id
client_secretSTRING客户端secret
返回对象的格式说明​
字段类型说明
access_tokenSTRINGaccess_token
token_typeSTRING固定值 "bearer"
expires_inSTRING有效时间,单位为秒,默认为12小时
scopeSTRING授权作用域,目前只支持 "sodu"

校验access_token​

校验access_token

请求URL​

http

GET /api/oauth2/server/tokens/check?token=${ACCESS_TOKEN} HTTP/1.1

1

URL 参数​
字段类型是否必须描述
tokenSTRING需较验的 access_token
返回对象的格式说明​
字段类型说明
access_tokenSTRINGaccess_token
token_typeSTRING固定值 "bearer"
expires_inSTRING有效时间,单位为秒
scopeSTRING授权作用域,目前只支持 "sodu"

撤销access_token​

撤销access_token

请求URL​

http

GET /api/oauth2/server/tokens/revoke?token=${ACCESS_TOKEN} HTTP/1.1

1

URL 参数​
字段类型是否必须描述
tokenSTRING待撤销的 access_token
返回对象的格式说明​
字段类型说明
codeINTEGER0 为成功,其它值为失败
msgSTRING操作结果

access_token及sudo说明​

access_token​

在Header中携带​

http

GET /api/{URI} HTTP/1.1
Authorization:Bearer ${ACCESS_TOKEN}

1
2

拼接在url中作为Query String Parameter的一部分​

http

GET /api/{URI}?access_token=${ACCESS_TOKEN} HTTP/1.1

1

sudo​

设置sudo​

sudo拼接在url中作为requestParam,sudo支持通过用户的id、loginName(登录名)、email(邮箱)、mobile(手机)传递用户身份。 以下四种sudo格式为:

  1. sudo=uid:${UID}
  2. sudo=loginName:${LOGIN_NAME}
  3. sudo=email:${EMAIL}
  4. sudo=mobile:${MOBILE}

注意

sudo=username:${LOGIN_NAME} (不推荐使用)

http

GET /api/{URI}?access_token=${ACCESS_TOKEN}&sudo=uid:${UID} HTTP/1.1

1

设置租户​

如果想使用sudo 功能,操作租户的数据,则要传递 tenantId 或者 tenantCode

http

GET /api/{URI}?access_token=${ACCESS_TOKEN}&sudo=uid:${UID}&tenantId=${tenantId} HTTP/1.1

1

http

GET /api/{URI}?access_token=${ACCESS_TOKEN}&sudo=uid:${UID}&tenantCode=${tenantCode} HTTP/1.1

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2078730.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

【Qt学习】Qlabel 的核心属性 与 代码实例

文章目录 1. 介绍2. 显示文本3. 显示图片4. 设置文本对齐方式5. 设置自动换行、边距、缩进6. 设置伙伴 1. 介绍 在Qt学习的专题中,我们以及多次使用过QLabel,作用就是用于显示文本和图片; QLabel有以下 核心属性: 好的&#xf…

EasyCVR视频汇聚平台:巧妙解决WebRTC无法播放H.265视频的难题

随着科技的飞速发展,视频监控已经成为现代安全管理不可或缺的一部分,广泛应用于智慧工地、智慧煤矿、智慧工厂、智慧社区和智慧校园等多个领域。在这个过程中,视频编码技术和实时通信技术显得尤为重要。EasyCVR视频汇聚平台,凭借其…

Python中的Request请求重试机制例子解析

在Python中,使用Requests库实现请求的重试机制是一种常见的做法,尤其是在面对不稳定的网络环境或服务时。以下是一些实现重试机制的详细例子: 使用Sessions和HTTPAdapter:Requests库中的Session可以存储跨多个请求的共同设置&…

城市内涝积水监测预警系统应对强降雨挑战

近年以来,我国部分地区频繁遭遇强降雨或持续性降水挑战,城市排水系统不堪重负,内涝问题日益凸显,下穿隧道、立交桥下等低洼路段容易产生大量积水,防洪形势刻不容缓。 为有效应对强降雨带来的挑战,国信华源结…

国内十大物联网平台推荐

随着物联网技术的飞速发展,越来越多的企业和开发者开始探索如何利用这一技术来优化产品、提高效率和创造新的商业模式。在中国,众多的物联网平台如雨后春笋般涌现,它们各具特色,为企业提供了丰富的选择。以下是国内十大物联网平台…

人工智能任务6-基于FAISS数据库的应用:向量数据库的搭建与中文文本相似度搜索

大家好,我是微学AI,今天给大家介绍一下人工智能任务6-基于FAISS数据库的应用:向量数据库的搭建与中文文本相似度搜索。随着大数据时代的到来,如何高效地处理和检索海量文本数据成为了研究的热点。在这个信息爆炸的时代&#xff0c…

【MySQL进阶之路】什么是事务以及事务的操作

目录 什么是事务 事务的属性 事务的操作 查看数据库引擎 事务提交 开始一个事务 提交事务 创建一个保存点 回滚到保存点 结论 注意事项 个人主页:东洛的克莱斯韦克-CSDN博客 什么是事务 事务是由一条或多条DML语句构成的。其中多条DML语句的执行必须有两…

【一起学Rust | 框架篇 | Tauri2.0框架】rust和前端的相互调用(前端调用rust)

文章目录 前言1. 前端调用rust(command)1. 在后端定义一个command2. 注册command3. 前端调用command 2. 前端调用rust(event)4. command完整实例 前言 本期将继续接着上一期,继续探索tauri中rust和前端的相互调用&…

视觉SLAM十四讲-理论到实践课程作业笔记-第六讲-光流法和直接法

CH6_No1: 1-1. 光流法可分为哪几类? 答:正向和逆向,其中两种方法各又包含了直加法和组合法; 1-2 在 compositional 中,为什么有时候需要做原始图像的 wrap?该 wrap 有何物理意义? 答:我个人的理解此处的wrap就是…

大数据系统测试——大数据系统解析(下)

各位好,我是 道普云 欢迎关注我的主页 希望这篇文章对想提高软件测试水平的你有所帮助。 学习和理解大数据系统每一个层次需要解决的技术问题和对应的一些技术需求是对大数据系统进行软件测试的一个基础,上篇文章里我们已经跟大家分享了数据收集层、…

33.python socket

python socket编程 概念说明心跳包的作用基于以上知识的基础上我们来实现一个代码socket serversocket client执行结果 概念说明 socket传输数据是基于字节流的,默认情况下是无边界的字节流。 一般情况下数据里中包含心跳包和数据包。数据包就是我们实际需要发送给…

中国建筑轮廓数据

建筑轮廓数据是建筑的边界矢量数据,一般该数据属性中会记录对应建筑的高度或者楼层数,通过建筑轮廓数据置顶的高程字段拉伸,就可以得到建筑白盒模型,所以,我们在各类导航地图中看到的白盒模型,实际上是建筑…

深度剖析:医疗行业财务报表的核心要素与解析策略

在当今医疗行业中,财务报表分析扮演着至关重要的角色。医疗机构需要通过对财务数据的准确分析来做出关键决策,管理资源,改善效率,并确保最终提供高质量的医疗服务。本文将深入探讨医疗行业中财务报表分析的重要性、关键指标和分析…

《一种个性化逻辑定制与类置换方案》

📢 大家好,我是 【战神刘玉栋】,有10多年的研发经验,致力于前后端技术栈的知识沉淀和传播。 💗 🌻 CSDN入驻不久,希望大家多多支持,后续会继续提升文章质量,绝不滥竽充数…

通过违法app发现大量网站被挂黑页

免责声明:文章来源于真实事件,关键信息已经打码处理,请勿利用文章内的相关技术从事非法测试,由于传播、利用此文所提供的信息或者工具而造成的任何直接或者间接的后果及损失,均由使用者本人负责,所产生的一…

AI搜索的商业模式困境:Perplexity从拒绝广告到高价广告的转变

随着人工智能技术的发展,AI搜索逐渐成为人们日常生活中不可或缺的一部分。在这个领域,Perplexity曾被认为是AI搜索领域的领军企业,以其强大的智能搜索能力脱颖而出。然而,随着OpenAI的SearchGPT发布在即,Perplexity似乎…

掌握结构型模式——全景回顾

在前几篇文章中,我们详细探讨了多种结构型设计模式,今天来进行一个大总结——结构型设计模式主要关注类与对象的组合和组织,确保我们能够构建出稳固、灵活且易于维护的软件系统。无论你是初学者还是有经验的开发者,这篇文章都会帮…

计算循环冗余码(CRC)--软考笔记

1、什么是CRC循环冗余码(CRC) CRC(Cyclic Redundancy Check)是一种用于检测数据传输错误的校验码。它通过一个预定义的生成多项式来计算一个固定长度的校验值,这个值被附加到原始数据上一起发送。接收端使用相同的生成…

二叉树 - 完全二叉树的节点个数

222. 完全二叉树的节点个数 方法一:递归 /*** Definition for a binary tree node.* function TreeNode(val, left, right) {* this.val (valundefined ? 0 : val)* this.left (leftundefined ? null : left)* this.right (rightundefined ? nul…

多商户2.3.0后台顶部添加修改密码修复方法

问题:后台登录不能修改自己的密码; 解决方法: 修改前端代码,文件路径(平台后台,商户后台一样的修改方法):src/layout/navBars/breadcrumb/user.vue 修改第一处 代码: 修…