伙伴云OpenAPI
  1. 服务商
伙伴云OpenAPI
  • 开发指南
    • 开发前必读
    • 申请 API Key
    • 基本概念介绍
    • 数据筛选器
    • 更新日志
  • 工作区
    • 获取工作区列表
      GET
    • 获取工作区成员列表
      POST
  • 表格数据
    • 获取表格列表
      POST
    • 获取表格配置
      POST
    • 查询数据列表
      POST
    • 获取数据详情
      POST
    • 创建数据
      POST
    • 更新数据
      PUT
    • 删除数据
      DELETE
    • 批量创建数据
      POST
    • 批量更新或创建数据
      PUT
    • 批量删除数据
      DELETE
  • 数据仓库数据
    • 获取数据仓库表格列表
      POST
    • 获取数据仓库表格配置
      POST
    • 查询数据列表
      POST
    • 获取数据详情
      POST
    • 批量创建数据
      POST
    • 批量更新数据
      PUT
    • 根据数据ID列表更新成相同数据
      PUT
    • 批量删除数据
      DELETE
  • 文件
    • 批量获取文件详情
    • 上传文件
  • 订阅
    • 订阅事件概述
    • Encrypt Key 加解密
    • 订阅回调事件
    • 添加订阅
    • 取消订阅
    • 获取订阅列表
  • 服务商
    • 获取 access_token
      POST
    • 获取服务商的 api_key
      POST
    • 获取服务商信息
      POST
    • 设置订阅回调地址
      POST
    • 获取订阅回调地址
      GET
  1. 服务商

获取服务商的 api_key

POST
/openapi/v1/isv/api_key
服务商需要通过 access_token 来将客户的 api_key 换成服务商级别的 api_key,之后可正常代客户调用相关业务接口。
服务商如直接使用客户的 api_key 进行调用,可能导致访问受限。
仅通过服务商的 api_key 进行的事件订阅会推送事件数据到服务商设置的回调地址,否则会回调给客户在企业后台为 api_key 设置的回调地址。
服务商 api_key 有效期为 2 小时,在此期间调用该接口 api_key 不会改变。当 api_key 有效期小于 30 分的时候,再次请求获取 api_key 的时候,会生成一个新的 api_key,与此同时老的 api_key 依然有效。

请求参数

Body 参数application/json
access_token
string 
访问授权
必需
通过“获取 access_token”接口获得
api_key
string 
客户授权
必需
客户从企业后台获得的接口授权
示例
{
  "access_token": "{{ACCESS_TOKEN}}",
  "api_key": "{{USER_API_KEY}}"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.huoban.com/openapi/v1/isv/api_key' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_token": "{{ACCESS_TOKEN}}",
    "api_key": "{{USER_API_KEY}}"
}'

返回响应

🟢200成功
application/json
Body
code
integer 
错误码
必需
0 为成功,小于 10000 为系统异常,其他为业务异常
message
string 
错误信息
必需
具体的错误原因,code 为 0 时返回“success”
data
object 
返回数据
必需
返回具体数据的结构
api_key
string 
服务商授权
必需
服务商代客户调用伙伴云业务接口的授权
expire
integer 
过期时间
必需
授权过期时间,单位: 秒
meta
object 
元数据
必需
用来描述返回数据原始信息
trace_id
string 
请求ID
必需
每次请求接口会返回唯一的ID
示例
{
  "code": 0,
  "message": "success",
  "data": {
    "api_key": "nEJDl4Lq8tBfpltycZ6OWJG3OyyySV4nR4Atqtj5",
    "expire": 7200
  },
  "meta": {
    "trace_id": "1652542326290522"
  }
}
上一页
获取 access_token
下一页
获取服务商信息
Built with