本文档描述在内容洞察API接口调用之前,客户侧需要做的前置准备工作
客户侧在完成前置的“火山引擎账号开通”→“基础配置”→“BMQ配置”之后,可以调用内容洞察API接口,进行订阅任务配置,并获取订阅数据。在调用接口前,需要做如下API基础配置。
说明
为了提高服务安全性,需要通过内容洞察API概览页设置IP白名单,即能够合法访问内容洞察API的IP列表,不在白名单列表中的IP地址的请求会被拒绝,并返回错误提示。
注意
支持配置多个火山公网IP地址,不支持配置IP网段
目前内容洞察API只提供一类访问凭证,即客户从内容洞察平台获得授权,不支持包括火山引擎在内的第三方授权。调用API之前,需要先调用内容洞察授权接口获取相应的访问凭证。
Step 1: 获取内容洞察账号和SecretKey
进入内容洞察平台-数据源管理页,获取调用API所需的内容洞察账号和SecretKey。
Step 2: 调用获取access_token接口,获取API访问凭证
注意
access_token的最大有效期是2小时。如果在有效期小于30分钟的情况下,调用本接口,会返回一个新的access_token,这会同时存在两个有效的access_token。
请求接口:
名称 | 内容 |
---|---|
接口地址 | oauth/access_token |
请求方式 | GET |
QPS限制 | 5 |
请求参数:
参数 | 类型 | 位置 | 是否必填 | 描述 |
---|---|---|---|---|
X-Insight-Biz-Name | string | Header | 是 | 业务名称 -> 火山账号ID |
X-Insight-Biz-Secret | string | Header | 是 | SecretKey |
正确返回:
{ "status": 0, "data": { "access_token": "here_is_your_access_token", "expire": 7200 }, "message": "succeed" }
完成上述全部步骤后,即可按照业务需要调用内容洞察API,相关API接口详见【左侧目录】-【接口列表】。
调用API时,需要将AccountID和访问凭证放入请求Header中。
调用API时,需要使用HTTPS或WSS协议。
获取视频互动数据
curl -X GET 'https://insight.volcengineapi.com/openapi/item/v1/interaction?post_id=6518198532704919524' \ --header 'X-Insight-Biz-Name: <account_id>' \ --header 'X-Insight-Access-Token: <access_token>' \ --header 'Content-Type: application/json; charset=utf-8'