Version: 简体中文

应用集成

1.概述#

为了更好地支撑客户个性化的业务需求，DM Hub REST API可以通过编程的方式与DM Hub交互。使用Open API来做客户、客户行为、客户标签、客户群组、订单等数据的接入和导出。首先在DM Hub创建应用，获取应用对应的App ID和App Secret用于API接口的调用。

2.新旧版本区别#

近期系统推出了新版本应用集成，新版本使用时需要调用API v2（v2目前还是Beta版本，旧版本使用的是API v1），因此创建应用时要特别注意是新版本还是旧版本。

  • 应用权限：新旧版本应用权限分类不同

  • IP白名单：旧版本的IP白名单为全局设置，对所有应用生效；新版本可以单独为每一个应用设置对应的IP白名单

  • API：旧版本应用需要配合API v1使用，新版本应用需要配合API v2使用

注意：在旧版本应用列表中，可以将某个应用迁移至新版本，迁移并不改变App ID和App Secret，迁移后需要调用API 2.0来实现相关功能，在弹窗界面中可以设置相关接口权限，迁移完成后可以在新版本界面里继续设置应用的IP白名单。

3.操作入口#

应用集成的功能入口：【设置中心】-【系统集成】-【应用集成】，

img

进入后默认显示的是旧版本应用

img

4.旧版应用#

4.1新建应用#

如下图所示，创建应用时，可依次填写以下信息，其中应用权限需要读还是写权限，请查看对应API的权限限制。

img

点击确定后，可以查看到该应用的App ID和App Secret，请妥善保管App Secret，为了保证账户安全，关闭窗口后，App Secret将不再显示，如需获取需要重新生成新的App Secret

img

注意：为了确保账户安全，关闭该信息弹窗后，应用秘钥将永远无法二次显示，请妥善保管好应用秘钥。

在应用列表页可以重置App Secret。

img

4.2添加IP白名单#

当前状态设置到启动状态，新增白名单。

img

最近拦截的IP地址默认进行统计和展示，若需要可以直接加入白名单

img

4.3迁移至新版本#

迁移并不改变App ID和App Secret，迁移后需要调用API 2.0来实现相关功能，下面可以设置相关接口权限，迁移完成后可以在新版本界面里设置应用的IP白名单。

img

5.新版应用#

5.1版本与URI#

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

https://api.convertlab.com/v2/{RESOURCE_PATH}

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

5.2创建应用#

切换到新版应用界面，创建应用，设置IP白名单。

img img

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

5.3获取access_token#

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

请求方式GET https://api.convertlab.com/v2/oauth2/token?app_id={APPID}&secret={SECRET}&grant_type=client_credentials 请求示例 请求地址

GET https://api.convertlab.com/v2/oauth2/token?app_id={APPID}&secret={SECRET}&grant_type=client_credentials
参数必填描述
app_id是应用的App ID
secret是应用的App Secret
grant_type是授权类型，这里必须是client_credentials

返回示例

{
"access_token": "dae7*********************e486",
"expires_in": 7200
}
参数类型描述
access_tokenString接口调用凭证
expires_in String接口调用凭证有效时间