Usage & Implementation

Preparing Your API for Circulex

  1. Register Endpoint: Register your API's base URL and payment address with the Circulex registry contract. This generates your unique target_hash.

  2. Configure Payment: Set up your endpoint to demand X402 payment upon unauthorized access (HTTP 402 response).

  3. Install Middleware: Integrate the Circulex SDK/Middleware into your API Gateway to check for the required SBT before granting access.

Best Practice: Initially issue short-lived certificates (e.g., 1-hour expiry) for maximum revenue security.

Last updated