获取访问令牌
广告主授权后,您会收到的授权码(auth_code),您可向以下接口发送请求,获取后续申请访问接口所需的访问令牌(access_token)。
生成访问令牌
若您想获取长期访问令牌时将Content-Type设置为application/json,您可以向 /oauth2/access_token/ 接口发送POST请求。需要在请求中传入app_id,auth_code 和secret。返回值包含该令牌能访问的广告主ID列表以及访问权限范围。
授权码有效时间为1小时,且只能使用一次。授权码过期后需要重新获得授权。
若您想获取长期访问令牌时将Content-Type设置为application/x-www-form-urlencoded,您需要调用/oauth/token/。
注意
如果访问令牌丢失,请及时通知广告主解除授权或者联系管理员进行操作。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径|v1.2/oauth2/access_token/|v1.3/oauth2/access_token/|
|请求参数类型 |app_id : number|app_id: string |
|返回参数类型|advertiser_ids: number[]|advertiser_ids`: string[]|
## 请求
**地址**
https://business-api.tiktok.com/open_api/v1.3/oauth2/access_token/
**方法**
POST
**Header**
```xtable
|字段|类型|描述|
|---|---|---|
|Content-Type {必填}|string|请求消息类型。允许值: `"application/json"`。 |
参数
|字段|类型|描述|
|---|---|---|
|app_id {必填}|string| 开发者应用 ID。<br><br>若想获取<strong>应用 ID</strong>,可以导航至<strong>[应用管理](https://ads.tiktok.com/marketing_api/apps/)</strong> > <strong>App Detail</strong> > <strong>基本信息</strong>。 |
|secret {必填}|string| 开发者应用密钥。<br><br>若想获取<strong>密钥</strong>,可以导航至<strong>[应用管理](https://ads.tiktok.com/marketing_api/apps/)</strong> > <strong>App Detail</strong> > <strong>基本信息</strong>。|
|auth_code {必填}|string|您的<strong>广告主授权 URL </strong>生成的授权码(`auth_code`)。<br><br>授权码有效期为 1 小时且只能使用一次。<br><br>若想了解您使用的 API 类别对应的授权码获取方式,可查看[不同 API 的授权流程对比](https://business-api.tiktok.com/portal/docs?id=1781891256601602#item-link-%E4%B8%8D%E5%90%8C%20API%20%E7%9A%84%E6%8E%88%E6%9D%83%E6%B5%81%E7%A8%8B%E5%AF%B9%E6%AF%94)中的"<strong>OAuth 授权 URL</strong>"行。 |
示例
(code curl http)
curl --location -request POST 'https://business-api.tiktok.com/open_api/v1.3/oauth2/access_token/' \
--header 'Content-Type: application/json' \
--data '{
"app_id": "{{app_id}}",
"secret": "{{secret}}",
"auth_code": "{{auth_code}}"
}'
(/code)
返回
|字段|类型|描述|
|---|---|---|
|code |number|返回码,详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|message |string|返回信息,详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|request_id |string|请求的日志 ID,唯一标识一个请求。 |
|data |object|返回数据。 |
#|access_token |string|用于权限验证的长期访问令牌。|
#|advertiser_ids |string[]|该访问令牌可以访问的广告账号列表。 |
#|scope |number[]|该访问令牌所拥有的权限。<br>您可查看[权限范围](https://ads.tiktok.com/marketing_api/docs?id=1753986142651394)了解权限范围 ID(`scope`的值)对应的权限。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"access_token": "{{access_token}}",
"advertiser_ids": [
"{{advertiser_id}}",
"{{advertiser_id}}"
],
"scope": [
18000000,
1,
2,
3,
4,
5,
6,
7,
8,
9,
7043626160646946818,
7050363942434013185,
7263200645266554881,
7294180478502830081,
7302558519668703234,
15000000,
10000,
19000000,
12000000,
7336834475000610818,
16000000,
20000000,
13000000,
17000000,
14000000
]
}
}
(/code);
撤销访问令牌
长期访问令牌不会过期,但是如果广告主取消授权,则长期访问令牌会失效。您可以使用接口/oauth2/revoke_token/撤销访问令牌。
长期令牌能够使用的接口取决于广告主授予的权限,而非您在创建开发者应用时申请的权限。
如果需要获得访问令牌能够操作的完整广告主列表,请使用/oauth2/advertiser/get/ 接口。
常见问题/常见报错信息
欲了解详细信息,请参考获取访问令牌-常见问题。
下一步
调用您的第一个 API 请求: - 参阅API 参考,获取 API 接口完整列表。 - 使用Postman 合集,进行 API 测试。 - 使用沙箱账户,在不影响您真实的 TikTok For Business 账户的情况下测试集成。