Provider onboarding

Publishing a service takes five steps. Your account can be a consumer and a provider at the same time.

1. Create a provider profile

Dashboard → Provide → Get started. Choose individual or company, a public display name and a URL slug, and accept the provider agreement, which discloses how earnings are calculated.

2. Create a service

A service is a CLI namespace (lowercase letters, digits and dashes, e.g. acme-weather). Give it a name, summary, category and tags (these power search), plus the upstream base URL the gateway should call. Upstreams must use HTTPS on a public address: private, loopback and link-local destinations are rejected at registration and again on every connection.

3. Upload your OpenAPI schema

Upload or paste an OpenAPI 3.0 or 3.1 document (JSON or YAML, up to 2 MB). It is validated immediately; you get a report of errors and warnings and a preview of the generated commands. See OpenAPI requirements. Each upload creates a new numbered version. Versions are reviewed before they become active, and changes that remove commands or add required inputs are flagged as breaking.

4. Set prices and authentication

• Prices: credits per successful call, per endpoint. Defaults come from x-clankerbay-price. Every change is recorded in the price history.
• Authentication: how the gateway authenticates to you: none, an API-key header (e.g. X-Api-Key), a bearer token, a query parameter, or HTTP basic (user:password). Secrets are encrypted with AES-256-GCM and only the gateway can decrypt them. Each change increments a version and is audited by fingerprint.

5. Submit for review

An administrator reviews your profile, the service and its schema. Once approved, the service appears in search, the directory and the CLI within a minute.

After launch

• Metrics: requests, successes, failures, status codes, timeouts, connection errors, p50/p95/p99 latency and last successful call per endpoint.
• Earnings: credits earned split by prepaid and subscription, monthly settlement statements, and cashouts.
• Payouts: complete Stripe Connect onboarding under Payout setup, then request cashouts of your available balance.

What your API receives

Requests arrive from the gateway with your configured credential and these informational headers:

X-Clankerbay-Request-Id: 01JA…
X-Clankerbay-Namespace: acme-weather
User-Agent: Clankerbay-Gateway/1.0

You never receive the consumer's identity or Clankerbay token. Respond within the service timeout (default 15 s, configurable up to 60 s).