Open Platform
Use an API key to securely read your own account profile, orders and feedback from the tools you already use.
API credentials
An API key grants access to the open API. Every key belongs to your account and can only read your own profile, orders and feedback.
Your account is unavailable. Please contact support.
Copy this key now
For security, the full key is shown only once. You cannot view it again after leaving this page — create a new one instead.
Never embed a key in client-side code or commit it to a repository, and never put it in a URL. Always call over HTTPS.
Create an API key
Name the key after its purpose, for example “my script”. The name is optional and limited to 80 characters.
API credentials
No API credentials yet
Create your first API key to start calling the open API.
API reference
The open API is read-only. Every endpoint is a GET request authenticated with the X-API-Key header.
Authentication
Send your API key in the request header. The server stores only a hash of the key and cannot recover the plaintext.
- Header
X-API-Key
curl "https://data.kuaiyizhi.cn/api/open/v1/me" \
-H "X-API-Key: ky_live_<your-key>"
curl "https://data.kuaiyizhi.cn/api/open/v1/orders?page=1&pageSize=20" \
-H "X-API-Key: ky_live_<your-key>"Endpoints
- GET
/api/open/v1/meReturns your account ID, email, email verification state, account status, signup time and last login time.
- GET
/api/open/v1/ordersReturns order ID, course ID, amount, status, payment method and timestamps in reverse chronological order. Transaction IDs and prepay data are omitted.
- GET
/api/open/v1/feedbacksReturns the feedback you submitted with its status and any administrator reply. Internal metadata and page URLs are omitted.
Pagination and filters
The list endpoints are paginated. The feedback endpoint additionally supports filtering by type and status.
| Parameter | Applies to | Description |
|---|---|---|
page | orders, feedbacks | Page number, defaults to 1. |
pageSize | orders, feedbacks | Items per page, defaults to 20, range 1 to 100. |
type | feedbacks | Feedback type: bug, feature, suggestion, question, other. |
status | feedbacks | Feedback status: pending, reviewed, resolved, closed. |
Response format
On success, data holds the result array and a pagination object. On failure the response carries success and error.
{
"success": true,
"data": {
"orders": [ /* … */ ],
"pagination": {
"page": 1,
"pageSize": 20,
"totalCount": 42,
"totalPages": 3,
"hasNextPage": true,
"hasPrevPage": false
}
}
}Error codes
- 400Pagination or filter parameters are invalid.
- 401The key is missing, invalid or revoked.
- 403The account is unavailable.