Table of Contents

切换 sWebApi 当前的登录企业

概述

名词解释

sWebAPI

授权方式

数据维度授权 企业级授权 此 API 为企业级授权，企业级授权和代理商级授权的授权账号均可以调用此 API。请参考 授权方式。
接口维度授权 默认授权 此 API 为默认授权，您无需为您的授权账号额外申请接口维度授权就可以调用。请参考 授权方式。

请求

请求域名

区域 域名
中国区 https://openapi.orionstar.com
欧洲区 https://global-openapi.orionstar.com
美国区 https://us-openapi.orionstar.com
日本区 https://jp-openapi.orionstar.com

请求协议

HTTP URL 路径 /v1/sso/init_webapi_access
HTTP Method GET

公共请求头

参数 类型 必填 说明
Authorization string 是
  • 访问凭证 access_token
  • 格式：Bearer access_token
  • 示例：Bearer T.WcnhSdYj-kwVBpP27LRQrw.OBt95zE4TH-OPzIX6OkEWPo4rbR6s.ori-67facfd90b2744220a5eae850e51
  • 请参考：鉴权方法

请求 URL 参数

参数 类型 必填 参数说明
ov_corpid string 是 需要切换（虚拟登录）的目标企业 id
access_scope string 否

虚拟登录的范围类型，在具体属于 sWebAPI 的 API 中会给出 SWebAPI 支持的范围类型。

  • corp
    • 企业后台（接待后台）的 SWebAPI
  • user
    • 机器人微信小程序的 SWebAPI

请求 cURL 示例

# 请根据您的区域替换域名
curl --location 'https://openapi.orionstar.com/v1/sso/init_webapi_access?ov_corpid=test_ov_corpid' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'

响应

公共响应体

参数 类型 参数说明
code int 错误代码。0 是成功，非 0 是失败，请参考 错误代码。
msg string 错误描述，当失败的时候会给出具体的错误描述。
req_id string 日志跟踪 id，当遇到问题需要猎户星空协助查问题时候，请提供此跟踪 id 值。
data object 业务数据 data 对象，详见下述 响应体 data 对象。

响应体 data 对象

参数 类型 参数说明
access_scope string 与请求参数中的 access_scope 相同
ov_corpid string 与请求参数中的 ov_corpid 相同

响应体示例

{
    "code": 0,
    "msg": "",
    "data": {
        "access_scope" : "corp",
        "ov_corpid" : "test_ov_corpid"
    }
}