# 服务端 OpenAPI

> 服务端 API 供后端服务以应用身份调用平台能力。根据用户要实现的能力先查本索引，再读取命中的详细文档。

## 使用方式

1. 先按接口名、HTTP Path 或业务场景在本文件中定位文档。
2. 读取命中的详细文档，按其中请求头、请求体、响应参数和错误码实现。
3. 涉及支付、回调验签、手机号密文解密或证书时，额外读取安全分组文档。
4. BaseDomain 是 `https://api.doubao-dev.com`。
5. 不要把 `app_secret`、`access_token`、私钥或证书明文写入前端 Page/Widget 或公开代码。

## 接口索引

### 服务端 API

服务端 OpenAPI 总览、鉴权模型和接口分类。

| 文档 | Method | HTTP Path | 鉴权/凭证 | 详细文档 |
| --- | --- | --- | --- | --- |
| 服务端 API | - | `` | 不适用 | [查看](openapi/overview/overview.md) |

### 登录

登录、OpenID、手机号和应用级 Token。

| 文档 | Method | HTTP Path | 鉴权/凭证 | 详细文档 |
| --- | --- | --- | --- | --- |
| 获取用户 OpenID | POST | `/api/login/v1/developer/get_openid` | app_id + app_secret | [查看](openapi/login/get-openid.md) |
| 获取用户加密手机号 | POST | `/api/login/v1/developer/get_user_phonenumber` | X-DB-AccessToken | [查看](openapi/login/get-user-phonenumber.md) |

### 获取调用凭证 Token

应用级调用凭证 client_token 获取。

| 文档 | Method | HTTP Path | 鉴权/凭证 | 详细文档 |
| --- | --- | --- | --- | --- |
| 获取调用凭证 Token | POST | `/api/token/v1/developer/get_client_token` | app_id + app_secret | [查看](openapi/token/get-client-token.md) |

### 支付

订单、退款、签约、协议支付和支付结果回调。

| 文档 | Method | HTTP Path | 鉴权/凭证 | 详细文档 |
| --- | --- | --- | --- | --- |
| 预下单 data 与 dbAuthorization | POST | `/requestOrder`（签名上下文） | 开发者私钥 + 开发者证书 | [查看](openapi/payment/request-order-data-and-authorization.md) |
| 代扣支付结果回调 | POST | `` | X-DB-Authorization 签名/验签 | [查看](openapi/payment/withhold-payment-result-callback.md) |
| 支付结果回调 | POST | `` | X-DB-Authorization 签名/验签 | [查看](openapi/payment/payment-result-callback.md) |
| 签约结果回调 | POST | `` | X-DB-Authorization 签名/验签 | [查看](openapi/payment/sign-result-callback.md) |
| 退款结果回调 | POST | `` | X-DB-Authorization 签名/验签 | [查看](openapi/payment/refund-result-callback.md) |
| 关闭协议支付订单 | POST | `/api/trade_basic/v1/developer/close_sign_pay` | X-DB-AccessToken | [查看](openapi/payment/close-sign-pay.md) |
| 创建协议支付订单 | POST | `/api/trade_basic/v1/developer/create_sign_pay` | X-DB-AccessToken + X-DB-SessionToken | [查看](openapi/payment/create-sign-pay.md) |
| 推送履约完成通知 fulfill_push_finish | POST | `/api/trade_basic/v1/developer/fulfill_push_finish` | X-DB-AccessToken | [查看](openapi/payment/fulfill-push-finish.md) |
| 订单查询 order_query | POST | `/api/trade_basic/v1/developer/order_query` | X-DB-AccessToken | [查看](openapi/payment/order-query.md) |
| 查询签约订单 | POST | `/api/trade_basic/v1/developer/query_sign_order` | X-DB-AccessToken | [查看](openapi/payment/query-sign-order.md) |
| 查询协议支付订单 | POST | `/api/trade_basic/v1/developer/query_sign_pay` | X-DB-AccessToken | [查看](openapi/payment/query-sign-pay.md) |
| 退款创建 refund_create | POST | `/api/trade_basic/v1/developer/refund_create` | X-DB-AccessToken | [查看](openapi/payment/refund-create.md) |
| 退款查询 refund_query | POST | `/api/trade_basic/v1/developer/refund_query` | X-DB-AccessToken | [查看](openapi/payment/refund-query.md) |
| 解除签约 | POST | `/api/trade_basic/v1/developer/terminate_sign` | X-DB-AccessToken | [查看](openapi/payment/terminate-sign.md) |

### 多任务管理

基于 `business-templates.yaml` 的远程任务创建和更新。

| 文档 | Method | HTTP Path | 鉴权/凭证 | 详细文档 |
| --- | --- | --- | --- | --- |
| 创建云端任务 | POST | `/api/task/v1/developer/create_remote_task` | X-DB-AccessToken + X-DB-SessionToken | [查看](openapi/task/create-remote-task.md) |
| 更新云端任务 | POST | `/api/task/v1/developer/update_remote_task` | X-DB-AccessToken + push_token | [查看](openapi/task/update-remote-task.md) |

### 服务通知

基于 `business-templates.yaml` 的服务通知发送。

| 文档 | Method | HTTP Path | 鉴权/凭证 | 详细文档 |
| --- | --- | --- | --- | --- |
| 发送服务通知 | POST | `/api/miniapp_notify/v1/developer/push_send` | X-DB-AccessToken | [查看](openapi/notice/push-send.md) |

### 签名认证及加密传输

证书、支付签名认证、回调验签和敏感数据加密传输。

| 文档 | Method | HTTP Path | 鉴权/凭证 | 详细文档 |
| --- | --- | --- | --- | --- |
| 签名认证及加密传输 | - | `` | X-DB-Authorization 签名/验签 | [查看](openapi/security/signature-authentication-and-encryption.md) |