How to publish an API

Veracity API Explorer lets you browse APIs available in the Veracity ecosystem. This guide explains how to publish your API so it appears there.

Veracity API Explorer lets you browse APIs available in the Veracity ecosystem. This guide explains how to publish your API so it appears there.

Veracity API Explorer replaced Veracity API Portal (deprecated by Microsoft). You can no longer test endpoints directly in the Explorer.

Before you begin

  • If you are new to Veracity, complete onboarding.

  • Ensure you have access to Developer Portal → My projects.

You have two options:

  • Use an existing production resource group If you already have a project and resource group approved for production, you can publish your API Product there. If the API is public, it will appear in Veracity API Explorer.

  • Use test or staging first If you do not have a production resource group, or prefer to validate first, publish to test or staging. After testing, contact the onboarding team to request production approval.

Publish an API

To publish an API:

  1. Create an API Product
  2. (Optional) Configure advanced settings
  3. Add an API Specification

All steps are performed in Developer Portal → My projects.

For general guidance, see publishing resources.

Create an API Product

  1. Go to Developer Portal → My projects.
  2. Open or create a project.
  3. Create or reuse a resource group.
  4. Select New Resource.
  5. Select API Product → Next.
  6. On Structure, select the project and resource group.
  7. On Configure:
    • Enter a name
    • Choose subscription approval settings
    • Enable Is public if required
    • Add a description
  8. On Advanced, configure throttling and Enable CORS if needed.
  9. On Summary, review and select Submit.

Configure advanced settings (optional)

Throttling

Limit API usage:

  1. Select a Counter Key (API Address or Subscription Key).
  2. Set Calls (maximum requests).
  3. Set Renewal period in seconds.
  4. Choose Increment condition (Success or Any).

CORS

Control allowed requests:

  1. Set Allowed origin (for example https://veracity.com).
  2. Select Allowed methods (GET, POST, PUT, etc.).

Add an API Specification

  1. Go to Developer Portal → My projects.
  2. Open the same project and resource group as the API Product.
  3. Select New Resource.
  4. Select API Specification → Next.
  5. On Structure, select the same project and resource group.
  6. On Configure:
    • Enter a name
    • Set subscription requirements
    • Assign one or more API Products
    • Select Upload type
    • Provide the API specification (Swagger/OpenAPI)
    • Enter the API Suffix
    • (Optional) Set version
  7. On Summary, review and select Submit.

Verify in API Explorer

Your API appears in Veracity API Explorer only if:

  • the API is public
  • at least one API Specification is assigned
  • the resource group is approved for production

If needed, contact the onboarding team.