Registering APIs
Publish your API on the marketplace. Start earning USDC per call.
Overview
When you register an API, it becomes visible to all consumers on the marketplace. They can browse your API, try it in demo mode for free, and then make paid calls.
Supported protocols
Opsalis supports six API protocols. Select the one that matches your API when registering:
| Protocol | Description |
|---|---|
| REST / OpenAPI | The most common API style. Upload an OpenAPI 3.x specification (JSON or YAML). Endpoints, parameters, and response schemas are auto-detected. |
| GraphQL | Query-based APIs. Upload or paste your GraphQL SDL (schema definition). Consumers see available queries, mutations, and types. |
| SOAP / WSDL | XML-based enterprise APIs. Upload or paste a WSDL file, or provide the WSDL URL. Optionally set a SOAPAction header. |
| gRPC / Protobuf | High-performance binary APIs. Upload or paste a .proto file. Provide the proto file path and service name so the system can locate your service definition. |
| JSON-RPC | Lightweight remote procedure calls over JSON. Upload or paste your method definitions. |
| XML-RPC | Simple remote procedure calls over XML. Upload or paste your method definitions. |
Registration form fields
Go to the API Management tab in your web console and fill in the registration form:
| Field | Description |
|---|---|
| API Name | A descriptive name for your API (e.g., "Weather Data Pro") |
| Price per Call (USDC) | How much you charge per API call (e.g., 0.01) |
| API Protocol | Select from REST/OpenAPI, GraphQL, SOAP, gRPC, JSON-RPC, or XML-RPC |
| Description | A short summary of what your API does (plain text, max 500 characters) |
| Tags | Comma-separated labels to help consumers find your API (e.g., "DeFi, Oracle, Pricing"). Up to 20 tags. |
| Keywords | Optional extra search terms. Keywords are also auto-extracted from the name and description. |
| Real API Endpoint URL | The base URL where your real API server is running. Must start with http:// or https://. |
| API Specification | Upload a file or paste the spec content. The format is auto-detected based on the protocol selected above. |
Protocol-specific fields
Some protocols require additional information:
- gRPC: Proto File Path and Service Name (e.g.,
package.ServiceName) - SOAP: WSDL URL (optional, if not pasting inline) and SOAPAction Header (optional)
These fields appear automatically when you select the corresponding protocol.
Validate and publish
Registration is a two-step process:
- Click "Validate API" — your control center checks that the API specification is valid, the endpoint is reachable, and the configuration is correct. Fix any errors shown.
- Click "Publish API" — this button appears after successful validation. Click it to make your API live on the marketplace.
Your API is now discoverable by all consumers on the network.
My Registered APIs
Below the registration form, the My Registered APIs section lists every API you have published. For each API you can see:
- API name, protocol type, and price
- Current mode (demo or live)
Each API has action buttons:
- Edit — change the name, description, price, or endpoint URL
- Delete — remove the API from the marketplace
- Set Demo / Go Live — toggle between demo mode (cached sample responses, free) and live mode (real API calls, paid). See Demo Mode for details.
Demo samples
During validation, the system calls 2–3 sample endpoints on your API and captures the real responses. These samples are shown to consumers as a free preview in demo mode.
2–3 samples recommended. Choose endpoints that best showcase your API. Consumers will evaluate your API based on these samples.
Your credentials are private
Your API key and base URL are never shared with consumers. Only your control center knows them. Consumers interact with your API through the Opsalis network, and your credentials stay on your machine.
After registration
Once published, your API appears in the catalog with a live status indicator. Consumers can see that your API is online and responding. If your API goes offline, the status updates automatically.