简介 - 抖音

抖音小程序、小游戏给开发者提供了服务端使用的 HTTPS API 接口。

access_token

access_token 是开发者调用服务端 API 的唯一凭证，开发者应该使用服务端 API 获取 access_token，并使用 access_token 调用其它服务端 API。

其中，access_token 最多2 小时即过期，重复获取 access_token 会导致上次 access_token 失效。为了平滑过渡，新老 access_token 在 5 分钟内都可使用。

请求参数格式说明

对于文档中提供的 GET 请求, 无特殊要求

对于文档中提供的 POST 请求, body 中的参数应以 JSON 字符串形式写入

当以 JSON 传递数据时候, 需要设置请求头 "content-type": "application/json"

沙盒能力介绍

抖音沙盒测试环境是抖音开放平台为第三方开发者提供的官方沙盒环境。开发者可以在该沙盒环境中创建沙盒应用，配合开发者的测试服务端和抖音沙盒环境服务端进行测试。但沙盒中创建的应用只能给开发者小范围测试使用，无法面向普通抖音用户进行发布和分发。

特别的，抖音沙盒环境为开发者提供了一套服务端 OpenAPI 能力，以供开发者调试使用。使用场景、操作步骤均与线上环境相同，所以参考线上文档即可。在抖音沙盒环境中使用时，仅需更换域名即可。

注意：目前，在抖音沙盒测试环境中存在的服务端 OpenAPI 能力，线上也均存在与之一一对应的能力；但并不是所有线上的能力，都支持抖音沙盒测试环境（是否支持请参考具体文档中是否存在沙盒 URL）。

沙盒环境的域名为 https://open-sandbox.douyin.com，开发者如需使用沙盒环境，将线上接口的域名更换为沙盒环境域名即可。

下面以登录接口（https://developer.toutiao.com/api/apps/v2/jscode2session）为例：将请求中的线上环境域名[https://developer.toutiao.com](https://developer.toutiao.com/)替换为沙盒环境域名[https://open-sandbox.douyin.com](https://open-sandbox.douyin.com/)，即可使用抖音沙盒测试环境中的登录接口。

沙盒环境中，课程库的部分 OpenAPI 能力需要在请求头字段中添加额外信息，如需使用请详细阅读课程库接口。

OpenAPI 列表

通用

模块	OpenAPI	描述
接口调用凭证	getAccessToken	为了保障应用的数据安全，只能在开发者服务器使用 AppSecret，如果小程序存在泄露 AppSecret 的问题，抖音小程序平台将有可能下架该小程序，并暂停该小程序相关服务。
登录	code2Session	为了保障应用的数据安全，只能在开发者服务器使用 AppSecret；开发者服务器不应该把会话密钥下发到小程序，也不应该对外提供这个密钥。如果小程序存在泄露 AppSecret 或会话密钥的问题，抖音小程序平台将有可能下架该小程序，并暂停该小程序相关服务。
二维码	createQRCode	获取小程序/小游戏的二维码。该二维码可通过任意 app 扫码打开，能跳转到开发者指定的对应字节系 app 内拉起小程序/小游戏，并传入开发者指定的参数。通过该接口生成的二维码，永久有效，暂无数量限制。
内容安全	内容安全检测	检测一段文本是否包含违法违规内容。
	图片检测V2	检测图片是否包含违法违规内容。

担保支付

模块	OpenAPI	描述
进件	发起进件请求	提交商户资料，开通商户号以收款或接收分账。
	图片上传接口	发起进件请求需要上传商户证件等图片，需要先调用图片上传接口获取 image_id。
	进件状态查询	开发者/服务商可以通过接口主动查询进件结果。
	进件状态回调	当进件成功或失败时，通知开发者/服务商进件状态。
支付	预下单接口	开发者/服务商系统先调用该接口在抖音小程序担保支付后台生成预支付单。
	唤起收银台	唤起收银台。
	支付结果查询	开发者/服务商可以通过支付结果查询接口主动查询订单状态，完成下一步的业务逻辑。
	支付结果回调	将用户支付成功消息通知给开发者/服务商。
退款	发起退款	交易时间超过 1 年的订单无法提交退款。
	退款结果查询	提交退款申请后，通过调用该接口查询退款状态。
	退款结果回调	回调可能存在延时，若实时性要求高，开发者可以通过主动请求查单接口，感知退款结果。
结算及分账	发起结算及分账	分账用于商户将交易成功的资金，按照一定的分账周期，分账给自身或者其他分账方。无论是否有分账方都需要主动的调用该接口才能进行在途资金的结算。
	结算及分账结果查询	查询结算及分账结果。
	结算及分账结果回调	本接口是整单回调，（无论几个分账方）整个分账单只需要回调一次。
退分账	发起退分账	支付订单已经分账的情况下发生退款，可以调用此接口将已分账的资金从分账接收方的账户回退给分账方，再发起退款。
	查询分账回退结果	商户需要核实回退结果，可调用此接口查询回退结果;如果分账回退接口返回状态为处理中，可调用此接口查询回退结果。
提现	商户余额查询	查询商户各渠道账户余额。
	商户提现	对可提现账户余额发起提现。
	商户提现结果查询	接口提供提现结果查询能力。
	商户提现回调	用于得知提现结果。
获取对账单	获取对账单	开发者/服务商可以通过对账单查询接口查询对应的账单。
接口获取页面链接	开发者获取小程序收款商户/合作方进件页面	获取进件页面链接，通过页面提交商户资料，开通商户号以收款或接收分账。
	服务商获取小程序收款商户进件页面	获取进件页面链接，通过页面提交商户资料，开通商户号以收款或接收分账。
	服务商获取服务商进件页面	获取进件页面链接，通过页面提交商户资料，开通商户号以收款或接收分账。
	服务商获取合作方进件页面	获取进件页面链接，通过页面提交商户资料，开通商户号以收款或接收分账。
	进件状态查询接口	提供进件结果查询接口，开发者/服务商可以通过接口查询到分账方进件结果。请求需要使用开发者/第三方平台提供的支付 SALT 进行加签。
	开发者获取小程序收款商户/合作方提现页面	获取账户余额页面链接，通过页面可查询余额及发起提现。
	服务商获取小程序收款商户提现页面	获取账户余额页面链接，通过页面可查询余额及发起提现。
	服务商获取服务商提现页面	获取账户余额页面链接，通过页面可查询余额及发起提现。
	服务商获取合作方提现页面	获取账户余额页面链接，通过页面可查询余额及发起提现。

泛知识课程库

OpenAPI	描述
【泛知识】上传课程资源	该接口用于上传课程资源，在调用课程上传接口前，需要先使用这个课程资源上传接口拿到返回的资源 uri。
【泛知识】查询课程资源上传状态	该接口用于查询课程资源的上传状态。
【泛知识】添加课程	该接口用于添加新课程，调用成功后会返回课程唯一标识 product_id 且课程会进审，审核通过后课程上架。
【泛知识】修改课程免审	该接口用于修改已有课程（包括上架课程及曾上架已下架课程），调用该接口修改的字段无需审核，成功后即生效，目前仅支持修改课程路径。
【泛知识】修改课程	该接口用于修改已添加或进审中的课程，调用成功后课程进审，审核通过后更新课程信息。调用修改课程接口不会影响已添加课程的上下架状态。
【泛知识】修改课程状态	该接口用于修改已有课程状态，可通过修改已有课程状态来实现上下架课程。
【泛知识】查询课程	该接口用于查询已添加和审核中的课程信息，单次查询不能超过 500 个课程。
【泛知识】回调通知	该接口用于同步课程库回调信息，在添加/修改商品，上传商品资源，以及检测到不合规的商品后，会将结果回调通知到已同步的地址。

订阅消息

OpenAPI	描述
发送订阅消息	用户产生了订阅模板消息的行为后，可以通过这个接口发送模板消息给用户，功能参考订阅消息。

简介

access_token#

请求参数格式说明#

沙盒能力介绍#

OpenAPI 列表#

通用#

担保支付#

泛知识课程库#

订阅消息#