API Integration guides
API Integration guides
Static proxy purchase workflow
A static proxy purchase order can contain multiple regions. After payment succeeds, fulfillment is asynchronous, and each region may succeed or fail independently.
sequenceDiagram
participant C as Client
participant A as Open API
participant W as Callback endpoint
C->>A: List static proxy regions
A-->>C: Return proxy types and region codes
C->>A: Get inventory for selected regions
A-->>C: Return inventory in request order
C->>A: Create a purchase order with regions
A-->>C: Return order number, order status, and region summaries
loop Until the order reaches a final status
C->>A: List purchase orders by order_no
A-->>C: Return order and region statuses
end
opt callback_url was provided
A->>W: Notify SUCCESS, PARTIAL_SUCCESS, or FAILED
W-->>A: Return any 2xx response
end
C->>A: List static proxy resources
A-->>C: Return connection details for fulfilled resources
Integration steps
- Call List static proxy regions and select one static proxy type and one or more region codes.
- Select one duration shared by all regions:
ISPsupports7and30days;ISP_NATIVEsupports7,30, and90days. - Call Get static proxy inventory and send the selected region codes in one POST request. Inventory is not reserved.
- Call Create a static proxy purchase order, put each region and its quantity in
regions, and save the returnedorder_no. - Every 10–30 seconds, call List static proxy purchase orders with an exact
order_nofilter until the order status isSUCCESS,PARTIAL_SUCCESS, orFAILED. - When the order status is
SUCCESSorPARTIAL_SUCCESS, call List static proxy resources to obtain connection details for successfully fulfilled regions.
If you provide callback_url, keep polling and reconciliation in place. A callback is only a notification and does not replace an order query.
FAILED and PARTIAL_SUCCESS results are not refunded automatically; contact customer support. Error 300320 during order creation means no price is available for the selected type, region, or duration.