对接流程

本文档主要说明对接的一般流程:

  • 开通开放平台接口调用权限。
  • 申请企业应用凭证(Client Id 和 Client Secret)。
  • 使用 OAuth 2.1 鉴权方式获取 access_token 和 refresh_token。
  • 在具体接口请求中携带 access_token 完成鉴权。
  • 介绍调试方法和调试工具。

开通开放平台接口调用权限

请联系您的客服人员或商务经理进行开通,开通后企业才能调用。

申请企业应用凭证

前往 CRM 设置中心 → 开发者中心 创建/管理企业应用,申请成功后可获得以下凭证:

参数 说明
Client Id 企业应用唯一标识,用于换取 token。
Client Secret 企业应用密钥,与 Client Id 配套使用,请妥善保管,不要泄露。

OAuth 2.1 鉴权方式

新接口统一采用 OAuth 2.1 认证方式,整体流程如下:

  1. 使用 Client Id + Client Secret 换取 access_token 和 refresh_token。
  2. 将 access_token 放入具体业务接口请求头中完成鉴权。
  3. access_token 过期后使用 refresh_token 刷新获取新的 access_token。
步骤一:获取 access_token 和 refresh_token

接口地址: /api/openapi/v2
接口文档: 获取访问凭证

步骤二:在具体接口请求头中携带 access_token

调用业务接口时,需要在 HTTP 请求 header 中添加:

Authorization: Token token=xxxxxxxx, device=open_api, version_code=9.9.9

Authorization 说明

参数 必填 说明
token 是 上一步获取的 access_token。
device 是 调用方客户端识别。对接开发值固定为 open_api,其他传值会导致错误。
version_code 是 接口版本号,对接开发值固定为 9.9.9,其他传值会导致错误。

调用举例

调用域名参考: 开发须知

curl --location --request GET '${host}/api/openapi/v2/customers' \
--header 'Authorization: Token token={access_token}, device=open_api, version_code=9.9.9'

调试方法和调试工具

使用 CURL 命令

curl --location --request GET '${host}/api/openapi/v2/customers' \
--header 'Authorization: Token token={access_token}, device=open_api, version_code=9.9.9'
文档更新时间: 2026-10-21 11:28   作者:明志朋