Skip to content

Commit 247377e

Browse files
committed
[DX-2372] docs: Add Publishing APIs Overview concept page
New concept page at portal/publishing-apis-overview.mdx covering the end-to-end publishing workflow for API Owners: prerequisites, the Provider-Product-Plan-Catalog dependency chain, building block descriptions with cross-links, and role overview. Also adds the page as the first entry in the Publishing APIs group in docs.json.
1 parent 84ea31a commit 247377e

2 files changed

Lines changed: 89 additions & 0 deletions

File tree

docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -531,6 +531,7 @@
531531
{
532532
"group": "Publishing APIs",
533533
"pages": [
534+
"portal/publishing-apis-overview",
534535
"portal/api-products",
535536
"portal/api-plans",
536537
"tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/manage-catalogues"
Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
title: "Publishing APIs Overview"
3+
description: "Understand the end-to-end workflow for making your APIs available to consumers in the Tyk Developer Portal, from configuring Providers to managing access requests."
4+
sidebarTitle: "Overview"
5+
keywords: "Developer Portal, Tyk, Publishing APIs, API Products, API Plans, API Catalog, API Provider, API Owner"
6+
---
7+
8+
## Introduction
9+
10+
The Tyk Developer Portal provides two views: an Admin Portal where API Owners configure and manage an API program, and a Live Portal where API Consumers discover APIs and request access. This page explains the publishing side of that separation — what an API Owner must configure before any consumer can find and use your APIs.
11+
12+
Publishing an API in the Developer Portal is not the same as deploying an API in Tyk Gateway. The Portal works at a higher level: you bundle APIs into Products, define consumption terms through Plans, and organize both into Catalogs that determine what each audience can see. Each building block depends on the one before it.
13+
14+
## Prerequisites
15+
16+
Three things must be in place before you can start publishing:
17+
18+
- **APIs configured in Tyk Dashboard** — The APIs you want to expose must already exist in Tyk Gateway and be accessible via Tyk Dashboard. The Developer Portal surfaces APIs from the Dashboard but does not manage Gateway configuration.
19+
- **A dedicated Tyk Dashboard API user** — The Portal needs a Dashboard user account with write access to APIs, Certificates, Keys, and Policies. This account is used when the Portal creates the access policies that back your Products and Plans.
20+
- **An Organisation and Team** — Consumers in the Live Portal belong to an Organisation and Team. Private Catalogs restrict visibility to specific Teams, so at least one Organisation and Team must exist before you can scope Catalog access.
21+
22+
## The Publishing Workflow
23+
24+
Once the prerequisites are in place, the publishing workflow builds up in layers. Each layer depends on the one beneath it:
25+
26+
```mermaid
27+
flowchart TD
28+
A[APIs in Tyk Gateway] --> B[Configure Provider]
29+
B --> C[Create API Products]
30+
B --> D[Create API Plans]
31+
C --> E[Publish API Catalog]
32+
D --> E
33+
E --> F[Consumers request access via Live Portal]
34+
F --> G[API Owner approves or rejects]
35+
```
36+
37+
**Providers** connect the Developer Portal to a Tyk Dashboard instance. Without a Provider, there are no APIs to bundle and no policies to create for your Products or Plans. Providers are configured in Portal Administration, not in the Publishing APIs section — they are a prerequisite shared by the entire portal, not specific to any one Product.
38+
39+
**API Products** bundle one or more APIs from a Provider into a single consumable offering. When you create a Product, the Portal automatically creates a corresponding access policy in the Provider. Products define *what* the consumer can access.
40+
41+
**API Plans** define the terms of that access: rate limits, usage quotas, key lifetime, and whether requests require manual approval. When you create a Plan, the Portal creates a corresponding limits policy in the Provider. Plans define *how much* the consumer can use and under what conditions.
42+
43+
**API Catalogs** bring Products and Plans together and expose them to a defined audience. Until a Product and a Plan appear in a Catalog, neither is visible in the Live Portal. Catalogs can be public (open to all visitors) or private (restricted to members of specific Teams).
44+
45+
**Consumer access requests** are the trigger for the final step. Consumers discover the Catalog, find a Product, select a Plan, and submit a provisioning request. Depending on the Plan's configuration, the request is either approved automatically or requires manual review.
46+
47+
## The Building Blocks
48+
49+
### Providers
50+
51+
A Provider represents a connection from the Developer Portal to a Tyk Dashboard instance. It makes the APIs, policies, and authentication mechanisms in that Dashboard available for use in Products and Plans. The portal supports multiple Providers, which is useful when you manage APIs across separate environments or teams.
52+
53+
See [API Providers](/portal/api-provider) for configuration details.
54+
55+
### API Products
56+
57+
An API Product is the primary unit of discovery in the Live Portal. It packages related APIs into a coherent offering with documentation, descriptions, and imagery that communicates the business value to consumers.
58+
59+
The Publishing APIs section covers several Product types:
60+
61+
- **Standard Products** — bundle live APIs, allowing consumers to request credentials and make API calls
62+
- **Documentation-only Products** — contain specifications and guides without live API access, useful for previewing upcoming APIs or publishing reference material
63+
- **GraphQL Products** — include GraphQL APIs with an interactive Playground for schema exploration
64+
- **Tyk Streams Products** — expose asynchronous, event-driven APIs built with Tyk Streams
65+
66+
See [API Products](/portal/api-products) for configuration details.
67+
68+
### API Plans
69+
70+
An API Plan defines the conditions under which a consumer can use a Product. Products define access; Plans define limits. The same Product can be offered under multiple Plans, allowing you to create tiered access for different consumer segments — for example, a free tier with lower rate limits alongside a premium tier with higher throughput.
71+
72+
Plans are not bound to a specific Product. Both Products and Plans are assigned to Catalogs independently, and consumers select a Plan at the time they request access.
73+
74+
See [API Plans](/portal/api-plans) for configuration details.
75+
76+
### API Catalogs
77+
78+
A Catalog is the discovery and access control layer of the Live Portal. It assembles a set of Products and Plans and makes them visible to a defined audience. A Product or Plan can appear in multiple Catalogs, so you can offer the same API to different audiences with different visibility and team restrictions.
79+
80+
See [API Catalogs](/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/manage-catalogues) for configuration details.
81+
82+
## Who Does This Work
83+
84+
All publishing tasks are performed by **API Owners** — the administrators who have access to the Admin Portal. API Owners are responsible for the full publishing lifecycle: configuring Providers, creating Products and Plans, publishing Catalogs, and reviewing consumer access requests. They also manage user accounts and portal-wide settings.
85+
86+
There is no separate publishing-only role. Any API Owner can perform all of these tasks.
87+
88+
See [API Owners](/portal/api-owner) for account management details.

0 commit comments

Comments
 (0)