谱蓝云 OpenAPI
  1. 接入指南
谱蓝云 OpenAPI
  • 接入指南
    • 基本概念介绍
    • 开发前必读
    • 获取 access_token
      GET
  • 回调通知
    • 客户
    • 组织架构
    • 商机
  • 获客拉新
    • 渠道活码
    • 加微任务
  • 客户管理
    • 企微客户
      • 获取客户商机记录
      • 更新客户资料
      • 更新客户标签
      • 创建客户动态
      • 获取客户标签数据
      • 获取客户资料信息
      • 获取客户关系与所在群聊
      • 开发中心-客户业务线归属
      • 搜索客户列表
      • 更新同步客户信息
    • 客户群
      • 客户群分页查询
    • 标签任务
  • 客户运营
    • 客户群发
    • 企微朋友圈
    • 群群发
      • 创建群群发任务
  • 营销活动
    • 营销 SOP
    • 直播管理
  • 内容中心
    • 基础素材
      • 创建基础素材
    • 自定义表单
      • 获取指定表单数据
  • 销售管理
    • 线索管理
      • 创建线索
    • 商机管理
      • 创建商机
      • 跟进商机
    • 工作日历
      • 创建日程
  • 会话存档
    • 聊天记录
      • 查询员工与客户的记录
  • 数据中心
    • 客户联系统计
  • 组织架构
  • 应用通知
    • 创建应用通知
  • 内部标签
    • 获取企业内部标签库
    • 添加内部标签
    • 编辑内部标签
    • 删除内部标签
    • 给线索打标签
    • 移除线索身上的标签
    • 给客户打标签
    • 移除客户身上的标签
  1. 接入指南

获取 access_token

开发中
GET
/open-api/system/oauth2/get-token
最后修改时间:2024-10-22 04:28:36

概述#

获取 access_token 是调用谱蓝云 SCRM OpenAPI 接口的第一步,相当于创建了一个登录凭证,其它的业务 API 接口,都需要依赖于 access_token 来鉴权调用者身份。

如何获取 appid 和 app_secret#

登录谱蓝云 SCRM 系统后台,在 设置--开发中心创建应用,创建完成后即可获取到应用的 client_id 和对应的 client_secret。
谱蓝云 SCRM 开发中心

注意事项#

开发者需要缓存 access_token,用于后续接口的调用(注意:不能频繁调用 get-token 接口,否则会受到频率限制拦截)。当 access_token 失效或过期时,需要重新获取。
access_token 的有效期通过 expires_in 来传达,正常情况下为 7200 秒(2小时),有效期内重复获取返回相同结果,过期后获取会返回新的access_token。
access_token 至少保留 512 字节的存储空间。
可能会出于运营需要,提前使 access_token 失效,开发者应实现access_token 失效时重新获取的逻辑。

请求参数

Query 参数
grant_type
enum<string> 
必需
授权类型,固定为 client_credentials
枚举值:
client_credentials
client_id
string 
必需
谱蓝云系统生成的的应用 ID
示例值:
{{client_id}}
client_secret
string 
必需
谱蓝云系统生成的的应用 secret
示例值:
{{client_secret}}
Header 参数
Authorization
string 
可选
默认值:
Bearer {{auth_token}}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/open-api/system/oauth2/get-token?grant_type=&client_id={{client_id}}&client_secret={{client_secret}}' \
--header 'Authorization: Bearer {{auth_token}}'

返回响应

🟢200成功
application/json
Body
code
integer 
状态码
必需
0 表示成功,非 0 表示失败
msg
string 
状态码描述
必需
data
object 
必需
access_token
string 
获取到的凭证
必需
最长为 512 字节
refresh_token
string 
刷新 token
必需
expires_in
number 
凭证有效时间
必需
单位(秒)
token_type
string 
必需
示例
{
    "code": 0,
    "data": {
        "access_token": "94eb05ac4810410eb7b2f3515045f6c9",
        "refresh_token": "29f790e4a58a44a4b72817fc6acf719e",
        "token_type": "bearer",
        "expires_in": 3555
    },
    "msg": ""
}
上一页
开发前必读
下一页
获取客户商机记录
Built with