You need to enable JavaScript to run this app.
导航
通过OpenAPI接入算法资源位
最近更新时间:2023.04.20 16:35:23首次发布时间:2023.01.04 15:52:11

强烈建议客户使用GMP SDK接入算法资源位功能,如果客户自己接入需使用v1版本的接口,通过ak/sk做鉴权,存在较大的安全风险;而使用GMP SDK接入,使用v3版本接口并使用全新的鉴权体系,更能保障用户数据安全。

1. 整体接入流程

alt

2. 接口说明

1. v1接口

/gmp/openapi/v1/resource_space/getRecResourceSpaceMaterial

使用ak/sk鉴权,ak/sk需通过火山引擎研发人员获取,参考以下说明计算签名信息,并放在请求HTTP请求Header的Authorization字段里。需要使用Post请求。

https://www.volcengine.com/docs/6285/65985#_5-%E7%A4%BA%E4%BE%8B%E4%BB%A3%E7%A0%81

2. v3接口

/gmp/openapi/v3/resource_space/getRecResourceSpaceMaterial

该版本接口目前只能通过GMP SDK接入,由SDK做鉴权处理

3. Request参数

{
    "app_id": 1,             // 项目id
    "key": "123",            // 资源位id
    "id": "789",             // 用户id
    "id_type": "1",          // 用户id类型
    "last_idx": 0,           // 分页字段, 首次传0, 后面传之前已拉回的总数
    "context_item_id": "123",    // 相关推荐场景
    "context_item_type": "123",
    "spm": "spm"             // 推荐算法字段
}

4. Response参数

{
    "code": 0, // 0成功
    "msg": "OK",
    "data": {
        "key": "123",
        "resource_id": 123,
        "type": 1,                  // 1: banner轮播, 2: 推荐列表
        "ab_sdk_version": "1",        // ab实验分组信息, 上报埋点带上
        "trans_data": "trans_data", // 推荐透传字段, 上报埋点使用
        "gmp_trans_data": "gmp_trans_data", // 推荐透传字段, 上报埋点使用
        "rec_material_list": [
            {
                "material_id": "11",
                "type": "1",
                "title": "",
                "customize_info": "{\"pic_url\":\"https://www.a.com/goods.jepg\", \"video_url\":\"https://www.a.com/video.mp4\"}" // JSON格式,客户自定义字段
            },
            {
                "material_id": "12",
                "type": "1",
                "title": "",
                "customize_info": "{\"pic_url\":\"https://www.a.com/goods.jepg\", \"video_url\":\"https://www.a.com/video.mp4\"}" // JSON格式,客户自定义字段
            }
        ]
    }
}