API 文档
Daas Admin 提供了全面的 API 接口，帮助您将支付系统与您的应用程序无缝集成。本文档详细介绍了所有可用的 API 端点、请求参数和响应格式。
API 概述
Daas Admin API 是一套基于 RESTful 风格设计的接口，使用 HTTPS 协议进行通信，数据格式为 JSON。所有 API 请求都需要进行身份验证，确保您的数据安全。
基本信息
- 基础 URL：https://api.your-daas-admin.com/v1
- 认证方式：Bearer Token
- 数据格式：JSON
- 字符编码：UTF-8
提示
在开始使用 API 之前，请确保您已在管理后台中创建了 API 密钥。您可以在"设置 → API 管理"中创建和管理您的 API 密钥。
认证与授权
所有 API 请求都需要通过 Bearer Token 进行身份验证。请在 HTTP 请求头中添加您的 API 密钥：
Authorization: Bearer YOUR_API_KEYAPI 密钥具有不同的权限级别，请确保您使用的密钥具有足够的权限来执行所需的操作。您可以在管理后台中为每个 API 密钥设置特定的权限范围。
支付相关 API
创建支付订单
POST /orders
请求参数
{
"product_id": "prod_123456",
"amount": 100.00,
"currency": "CNY",
"customer_id": "cus_123456",
"payment_method": "alipay",
"description": "订购高级套餐",
"metadata": {
"source": "website"
}
}响应示例
{
"id": "ord_123456",
"status": "pending",
"amount": 100.00,
"currency": "CNY",
"payment_url": "https://pay.example.com/checkout/ord_123456",
"created_at": "2023-06-01T12:00:00Z",
"expires_at": "2023-06-01T12:30:00Z"
}查询支付订单
GET /orders/:id
响应示例
{
"id": "ord_123456",
"status": "paid",
"amount": 100.00,
"currency": "CNY",
"customer_id": "cus_123456",
"payment_method": "alipay",
"payment_details": {
"transaction_id": "2023060112345678",
"paid_at": "2023-06-01T12:05:30Z"
},
"created_at": "2023-06-01T12:00:00Z"
}错误处理
API 使用标准的 HTTP 状态码来表示请求的结果。2xx 表示成功，4xx 表示客户端错误，5xx 表示服务器错误。所有错误响应都包含一个 JSON 对象，其中包含错误的详细信息。
错误响应示例
{
"error": {
"code": "invalid_request",
"message": "订单金额必须大于 0",
"param": "amount",
"request_id": "req_123456"
}
}常见错误代码
- invalid_request：请求参数错误
- authentication_error：认证失败
- permission_denied：权限不足
- resource_not_found：请求的资源不存在
- rate_limit_exceeded：超过 API 调用频率限制
- server_error：服务器内部错误