快速开始
5 分钟完成 ipayxx API 首次集成
提示
API 密钥管理功能将在 Phase 2 上线。当前阶段可使用测试密钥进行开发调试。
第一步:获取 API 密钥
登录 ipayxx 控制台,进入「开发者设置」页面,创建 API 密钥对。每个密钥对包含:
API Key- 用于标识您的身份API Secret- 用于请求签名,请妥善保管
Base URL: https://api.ipayxx.cn/v1
第二步:创建订单
使用 POST /v1/orders 接口创建一笔新订单:
请求示例
POST /v1/orders HTTP/1.1
Host: api.ipayxx.cn
Authorization: Bearer your_api_key
Content-Type: application/json
{
"product_id": "prod_demo_001",
"amount": 9900,
"currency": "CNY",
"description": "专业版许可证 - 1年期",
"buyer_email": "[email protected]",
"metadata": {
"source": "website"
}
}响应示例
{
"code": 0,
"data": {
"order_no": "ORD20260308001",
"status": "unpaid",
"amount": 9900,
"currency": "CNY",
"pay_url": "https://pay.ipayxx.cn/checkout/ORD20260308001",
"expires_at": "2026-03-08T11:00:00Z",
"created_at": "2026-03-08T10:00:00Z"
}
}第三步:查询订单
使用 GET /v1/orders/:order_no 查询订单状态:
GET /v1/orders/ORD20260308001 HTTP/1.1 Host: api.ipayxx.cn Authorization: Bearer your_api_key
{
"code": 0,
"data": {
"order_no": "ORD20260308001",
"status": "paid",
"amount": 9900,
"currency": "CNY",
"paid_at": "2026-03-08T10:05:00Z",
"license_key": "LIC-XXXX-XXXX-XXXX-XXXX"
}
}第四步:激活授权
支付成功后,用户通过 POST /v1/licenses/activate 激活授权:
POST /v1/licenses/activate HTTP/1.1
Host: api.ipayxx.cn
Content-Type: application/json
{
"license_key": "LIC-XXXX-XXXX-XXXX-XXXX",
"device_id": "device_fingerprint_abc123",
"device_name": "MacBook Pro"
}{
"code": 0,
"data": {
"license_key": "LIC-XXXX-XXXX-XXXX-XXXX",
"status": "activated",
"device_id": "device_fingerprint_abc123",
"activated_at": "2026-03-08T10:10:00Z",
"expires_at": "2027-03-08T10:10:00Z"
}
}下一步
- 认证与签名 - 了解请求签名机制
- Webhook 集成 - 接收实时事件回调
- 示例代码 - 查看多语言 SDK 用法