OpenAPI Documentation
OpenAPI Documentation

Dynamic proxy workflow

A typical dynamic proxy integration includes purchasing traffic, creating a dynamic sub-account, selecting a region, and generating connection credentials.

sequenceDiagram
    participant C as Caller
    participant A as Open API
    participant P as Proxy endpoint

    C->>A: List dynamic traffic products
    A-->>C: Return product codes and purchase rules
    C->>A: Purchase dynamic traffic (request_no)
    A-->>C: Return COMPLETED and traffic batch ID
    C->>A: Create dynamic sub-account (request_no)
    A-->>C: Return sub-account information
    C->>A: List available regions
    A-->>C: Return region codes
    C->>A: Generate proxy connection credentials
    A-->>C: Return host, port, username, and password
    C->>P: Connect using the credentials

Integration steps

  1. Call List dynamic traffic products, then select a product_code and an allowed traffic specification. Tiered prices are accumulated according to the quantity covered by each tier. Query results are estimates only.
  2. Optionally call Get wallet balance to confirm the available balance.
  3. Call Purchase dynamic traffic. The price is recalculated using the effective price at order time. This API completes synchronously and returns COMPLETED on success.
  4. Call Create a dynamic sub-account. The available dynamic traffic balance must be greater than 0 before account creation.
  5. Call List dynamic proxy regions progressively by country, province/state, and city.
  6. Call Generate dynamic proxy credentials, then connect using the returned information.

During operation

Connection credentials are sensitive. Generate and use them only when establishing a proxy connection, and do not persist them in ordinary business logs.

On this page