接入指南

荟聚 REST API让您能够通过编程的方式与荟聚交互。使用Open API来做线索、线索行为、线索标签、线索群组、订单等数据的接入和导出。

版本与URI

荟聚 REST API第2版是最新版，其地址结构具有以下形式：

https://api.huiju.cool/v2/{RESOURCE_PATH}

其中RESOURCE_PATH是具体资源的API路径。

创建应用

在开始使用REST API之前需要先创建一个应用，以获取App ID和App Secret。具体请进入 荟聚 > 设置中心 > 应用集成。

创建应用后，妥善保管应用ID（App ID）和应用密钥（App Secret）。

获取access_token

荟聚 REST API使用OAuth v2.0协议做认证授权协议。访问荟聚 REST API时需要携带访问令牌（access_token）作为认证凭证。 开发者需要妥善保存。access_token的有效期为2小时，需要定时刷新。

默认接口请求频率限制：10次/分。