Getting Started

1. Credentials

Each dealer tenant receives Open API credentials:

Field	Header / usage
AppKey	RT-AccessCode
AppSecret	HMAC signing key (shown once at creation)

Configure optionally in the admin console: callback URL, IP allowlist, QPS limits.

2. Conventions

• Base URL: provided by the platform, e.g. https://api.example.com
• Protocol: HTTPS + POST + Content-Type: application/json
• Path prefix: /open-api/v1
• Identity: AppKey maps to dealer tenant — no shopId
• Payment: orders debit the dealer BALANCE wallet

3. First health check

POST /open-api/v1/health
Content-Type: application/json
RT-AccessCode: {AppKey}
RT-RequestID: {UUID}
RT-Timestamp: {millis timestamp}
X-Signature: {signature}

{}

See Health Check for response fields.

4. Recommended integration order

1. health — verify signing & connectivity
2. account/balance — check wallet balance
3. package/list — list sellable packages
4. esim/order — create order (transactionId is idempotent)
5. esim/query — query order status
6. esim/profile/list — list allocated profiles
7. webhook/set — receive ORDER_PAID / DELIVERY_UPDATED

5. Apifox import

1. Import openapi.yaml
2. Environment: OPENAPI_APP_KEY, OPENAPI_APP_SECRET, OPENAPI_BASE_URL
3. Download Apifox pre-request script and paste into project pre-request hook

See Authentication.