Skip to content

Marketplace & Storefront

The Marketplace is your organisation’s branded API storefront. It’s automatically generated from your API catalogue and serves as the discovery layer for both internal teams and external consumers.

Every published API appears in the marketplace with:

InformationSource
Name, description, business functionAPI metadata
Interactive documentationGenerated from OAS
SLA tiers and pricingOpenSLA definition
Version historyDeployment records
Compliance scoreCompliance service
Subscription optionsAvailable tiers + self-service subscribe

Each tenant gets a branded developer portal at their own subdomain:

{tenant}.dev.apiway.net

The storefront inherits your branding and shows only the APIs you’ve published for external consumption. Internal APIs stay hidden.

Producers control who can see each API:

VisibilityWho Can See It
TeamOnly the owning team
Functional AreaTeams within the same business function
OrganisationEveryone in the tenant
Invitation OnlySpecific invited consumers
PartnerPartner organisations
PublicAnyone — visible in the marketplace

The marketplace is backed by the Marketplace API — a dedicated catalogue service:

  • Core-service publishes API metadata via upsert (PUT /v1/apis)
  • Marketplace API stores in MongoDB (single database, not per-tenant)
  • Portals query with visibility filtering based on the caller’s JWT
  • Anonymous access (external portal) only sees Public APIs scoped to the tenant

This separation means the catalogue is always fast and available — it doesn’t depend on core-service for reads.

External consumers access your APIs through the developer portal:

  1. Browse — Discover available APIs by name, function, or capability
  2. Read docs — Interactive API documentation generated from the OAS
  3. Compare tiers — See what each SLA tier offers (rate limits, RU quota, pricing)
  4. Subscribe — Self-service subscription with automatic credential provisioning
  5. Manage — View active subscriptions, credentials, and usage

When you publish a new version, the marketplace tracks the change:

  • Non-breaking (minor/patch) — Existing consumers are unaffected, docs update automatically
  • Breaking (major) — New version appears alongside the old one; consumers migrate at their own pace
  • Deprecation — Old versions are marked with a retirement date; consumers are notified

APIs flagged for external visibility are discoverable across tenant boundaries through the API Economy. Consumers from other organisations can subscribe — the OAS is copied into their tenant and goes through their own governance flow. Full tenant isolation is maintained.