Open API Documentation

This documentation is intended for developers integrating with the Open API from server-side applications. It covers authentication, business workflows, request parameters, response structures, and error handling.

Get started

• Integration overview: Learn about environments, available APIs, and the recommended reading path.
• Authentication: Manage API keys in the web console and authenticate requests with an HTTP header.
• Quickstart: Make your first API call.
• API list: Find APIs by wallet, dynamic proxy, or static proxy capability.

Read by task

• Purchase and use dynamic traffic: See the Dynamic proxy workflow.
• Purchase static proxies: See the Static proxy purchase workflow.
• Renew static proxies: See the Static proxy renewal workflow.
• Receive order notifications: See Callback notifications.

Important conventions

• All business APIs authenticate requests through the X-API-Key header.
• When a request reaches the Open API and the Open API produces a normal response, the business result is returned with HTTP 200. Always use the response body code to determine the result. Only code = 0 means success. This convention does not apply to transport failures.
• You must provide a request_no when purchasing dynamic traffic, creating a dynamic sub-account, creating a static proxy purchase order, or creating a static proxy renewal order. Reusing the same request number during its protection period is rejected.
• Static proxy order callbacks are notifications only. Whether or not you receive a callback, treat the order query API as the source of truth.

Service endpoints

Environment	Base URL
Test	https://api-test.puraroute.com/gin
Production	https://api.puraroute.com/gin

Commands in this documentation use the test environment by default. Before going live, replace the Base URL with the production endpoint.