Have an API to sell?
Invokora Help Center
Invokora Help CenterSell APIs and services
Getting started

Publish your first API product

Use one endpoint, one origin, and a free BASIC plan to import, grant access, test, and publish.

On this page

Before you start

  • Your merchant email is verified.
  • You control a public HTTPS API. This example assumes GET /health returns HTTP 200 with {"status":"ok"}. If your API differs, replace the example path and response.

1. Describe your product

  1. Open Products → New product. Under General, choose API product.
  2. For example, use status-api as the product URL suffix, “Service Status API” as the title, and describe what the API returns, who it is for, and how to contact you.
API product General fields show the status-api URL suffix, product type, title, and description.
Enter the product URL suffix, title, and description under General. Screenshot uses local demo data. View full-size image (opens in a new tab)
Create an API product

2. Import the API document and connect your origin

  1. Open Endpoint. In the default origin group, enter your HTTPS base URL, such as https://api.your-domain.com. This is a placeholder: replace it with your own reachable origin.
  2. Paste the YAML below into OpenAPI document, or save it as status-api.yaml and upload it with Import JSON or YAML. Keep default as the default origin group and leave routes and transformations empty.
  3. Select Save draft. After saving, Parsed endpoints should include GET /health. Your API handle comes from your store handle; there is no separate domain to enter.
The default origin group contains an example HTTPS URL and is selected as the default group.
Under Endpoint, enter your HTTPS origin and select the default group. Local demo data is shown; replace example.com with your own address. View full-size image (opens in a new tab)
Importable status-api.yaml
openapi: 3.0.3
info:
  title: Status API
  version: 1.0.0
paths:
  /health:
    get:
      operationId: getHealth
      summary: Check service health
      responses:
        '200':
          description: Service is healthy
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: ok
Configure origin authentication

3. Give BASIC access to the endpoint

  1. Open Pricing and expand BASIC. Keep the defaults: a USD 0 monthly base, 10 Requests per month, Hard enforcement, and 10 requests per second.
  2. Under Plan endpoint access, select GET /health. Keep the plan public and enabled. Imported endpoints are not granted to the default plan automatically.
  3. Save the draft again. This plan does not charge object overage, so buyers do not need a card to subscribe.
The plan is enabled and public, limits calls to 10 per second, and grants GET /health under Plan endpoint access.
Under Pricing, select the granted endpoint and confirm the plan is enabled and public. Screenshot uses local demo data. View full-size image (opens in a new tab)

4. Send a real test request

  1. Return to Endpoint, choose BASIC under Test plan, and select GET /health.
  2. Send the request. Confirm a 200 response that matches your API and check Saved test evidence.
  3. If you change the origin, document, or authentication, save and test again. Tests reach your real origin and may incur upstream charges or perform real actions.
The merchant Try It console selects GET /health and shows HTTP 200 after sending.
Select an endpoint, send a test, and check the status. HTTP 200 is a local demo response; the host belongs to the local test environment. View full-size image (opens in a new tab)

5. Preview, publish, and check the buyer page

  1. Open Preview and check the title, description, BASIC price, Requests allowance, and endpoint access.
  2. Select Publish. After publication, open the public product page from Products.
  3. In a signed-out window, confirm the Free trial entry and GET /health documentation are visible. Share the product link and the buyer calling guide with your customer.
Read the buyer’s first-call guide

Check your result

  • Your public product page shows the BASIC free trial and GET /health documentation, ready for a buyer to follow the calling guide.

You may need next