Back to HomeAPI Docs
Language: English
简体中文English繁體中文（台灣）繁體中文（香港）Tiếng Việtالعربية日本語한국어ไทยBahasa IndonesiaBahasa MelayuPortuguêsEspañolFrançaisDeutschРусскийTürkçeहिन्दीItalianoPolskiУкраїнськаFilipinoবাংলা

Open API Documentation

Complete integration reference and interactive tools for account, device, and certificate APIs.

Account

Balance, pricing, and tokens
Query Balance
Stable
Retrieve the user balance using the token
GET/api/balance
v1.0.0
Get Price
Stable
Retrieve device pricing filtered by type (instant/review), warranty, and device type. Returns the user IP address
GET/api/price
v1.0.0
Query Token Expiry
Stable
Retrieve the expiry time and validity status of an API token
GET/api/token/expire
v1.0.0
Update Token Expiry
Stable
Update the expiry timestamp of the current API token. Set expire_time to 0 to make it permanent.
POST/api/token/expire
v1.1.0
Update Token
Stable
Generate a new API token and invalidate the old token immediately.
POST/api/token/update
v1.1.0

Device Management

Register, query, and maintain devices
Add Device (Instant)
Stable
Register a device UDID and return mobileprovision and P12 immediately
POST/api/adddevice
v2.1.0
Add Device V2
Stable
Unified single-device add API. Switch between instant and reservation mode with one parameter while keeping legacy APIs available.
POST/api/adddevice/v2
v2.2.0
Add Device (Review/Reservation)
Stable
Register a device in reservation mode. mobileprovision may be empty while Apple review is pending
POST/api/addyydevice
v2.1.0
Batch Add Devices
Stable
Batch register multiple UDIDs with flexible defaults and per-item overrides. Each item can use instant or reservation mode.
POST/api/adddevice/batch
v2.2.0
Get Device Info
Stable
Query detailed device information by KID or UDID using token authentication.
GET/api/device/info
v1.0.0
Get Device List
Stable
Query the authenticated user device list with pagination and status filters.
GET/api/device/list
v1.0.0
Update Device Remark
Stable
Update a device remark using token authentication
POST/api/device/remark
v1.0.0
Set Device Status
Stable
Update the status of a device using token authentication
POST/api/device/status
v1.0.0
Renew Device Membership
Stable
Batch update device membership expiry with flexible matching and renewal modes.
POST/api/device/membership/renew
v1.1.0

Certificates

Query, download, and verify certificates
Get Certificate
Stable
Retrieve a certificate using the token and either a certificate ID or UDID. Smart selection applies when querying by UDID
GET/api/getcertificate
v1.0.0
Check Certificate Status
Stable
Check certificate status using token authentication and either a certificate KID or device UDID
GET/api/device/certcheck
v1.0.0

App Sources

App source and application management APIs
List sources
Stable
List sources. Manage only sources owned by this token on the current tenant.
GET/api/appstore/manage/sources
v1.0.0
Create source
Stable
Create source. Manage only sources owned by this token on the current tenant.
POST/api/appstore/manage/sources
v1.0.0
Get source settings
Stable
Get source settings. Manage only sources owned by this token on the current tenant.
GET/api/appstore/manage/sources/:source_id
v1.0.0
Update source settings
Stable
Update source settings. Manage only sources owned by this token on the current tenant.
PATCH/api/appstore/manage/sources/:source_id
v1.0.0
List source apps
Stable
List source apps. Manage only sources owned by this token on the current tenant.
GET/api/appstore/manage/sources/:source_id/apps
v1.0.0
Add source app
Stable
Add source app. Manage only sources owned by this token on the current tenant.
POST/api/appstore/manage/sources/:source_id/apps
v1.0.0
Get source app
Stable
Get source app. Manage only sources owned by this token on the current tenant.
GET/api/appstore/manage/sources/:source_id/apps/:app_id
v1.0.0
Update source app
Stable
Update source app. Manage only sources owned by this token on the current tenant.
PATCH/api/appstore/manage/sources/:source_id/apps/:app_id
v1.0.0
Reorder source apps
Stable
Reorder source apps. Manage only sources owned by this token on the current tenant.
PUT/api/appstore/manage/sources/:source_id/apps/order
v1.0.0
Publish app draft
Stable
Publish app draft. Manage only sources owned by this token on the current tenant.
POST/api/appstore/manage/sources/:source_id/apps/:app_id/publish
v1.0.0
Source statistics
Stable
Source statistics. Manage only sources owned by this token on the current tenant.
GET/api/appstore/manage/sources/:source_id/stats/overview
v1.0.0
Quick source setup
Stable
Quick source setup. Manage only sources owned by this token on the current tenant.
POST/api/appstore/manage/quick-setup
v1.0.0