You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: "Create API Products in the Tyk Developer Portal that publish OpenAPI or GraphQL documentation without exposing live API access or credentials. Useful for pre-release APIs, partner previews, and archived docs."
3
+
description: "Create API Products in the Tyk Developer Portal that publish documentation without exposing live API access or credentials. Useful for pre-release APIs, partner previews, and archived docs."
Documentation-Only Products let you publish API documentation in the Developer Portal without creating any access policy or issuing credentials. Consumers can browse your documentation, explore the interactive playground, and review specifications, with no "Request Access" button and no plan selection.
8
+
Documentation-Only Products let you publish API documentation in the Developer Portal without creating any access policy or issuing credentials. Consumers can browse your documentation, explore the interactive playground, and review specifications, with no "Request Access" button and no Plan selection.
9
+
10
+
In this section we will refer to those Products that can be combined with Plans to issue credentials as *Regular Products*.
9
11
10
12
## When to use a Documentation-Only Product
11
13
@@ -27,15 +29,15 @@ For an overview of API Products, see [API Products](/portal/api-products). For s
27
29
28
30
## Create a Documentation-Only Product
29
31
30
-
There is no explicit documentation-only toggle in the Admin UI. A product becomes documentation-only automatically when no APIs are selected on the APIs tab. The Portal skips policy creation in the connected Tyk Dashboard, so no access policy or credentials are ever generated for the product.
32
+
There is no explicit documentation-only toggle in the Admin UI. A Product becomes documentation-only automatically when no APIs are selected on the APIs tab. No access policy will be created in the connected Tyk Dashboard, so no credentials can be generated for the Product.
31
33
32
34
1.**Navigate to API Products**
33
35
34
36
In the Admin Portal, go to **Developer Portal** > **API Products** and select **Add new API Product**.
35
37
36
38
2.**Skip API selection**
37
39
38
-
Open the **APIs** tab. Do not select any APIs from the list. Skip to the next tab. This is what makes the product documentation-only.
40
+
Open the **APIs** tab. Do not select any APIs from the list. Skip to the next tab. This is what makes the Product documentation-only.
39
41
40
42
41
43
@@ -50,65 +52,65 @@ There is no explicit documentation-only toggle in the Admin UI. A product become
50
52
51
53
52
54
53
-
4.**Fill in product details**
55
+
4.**Provide the Product details**
54
56
55
57
Open the **Details** tab and complete the following:
56
58
57
-
1.**Product name**: use a clear, descriptive name. Consider a convention such as "[DOCS] Payment Integration Guide" so admins can distinguish documentation-only products at a glance.
59
+
1.**Product name**: use a clear, descriptive name. Consider a convention such as "[DOCS] Payment Integration Guide" so admins can distinguish documentation-only Products at a glance.
58
60
2.**Catalog display name** and **Product summary**: the summary appears as the tile description in the Live Portal.
59
-
3.**Product description**: make clear in the description that this product is documentation-only and consumers cannot request access.
61
+
3.**Product description**: make clear in the description that this Product is documentation-only and consumers cannot request access.
60
62
4.**Product image** (optional): JPG or PNG, recommended 700x400 pixels.
61
-
5.**Publish API product to catalogue**: select one or more Catalogs.
63
+
5.**Publish API Product to catalogue**: select one or more Catalogs.
62
64
63
-
5.**Add Getting Started guides (optional)**
65
+
5.**Add Getting Started Guides (optional)**
64
66
65
-
Open the **Getting started guides** tab to create Markdown or HTML pages. These appear on the product's **Get Started** tab in the Live Portal and are the right place for tutorials, integration walkthroughs, and conceptual overviews.
67
+
Open the **Getting Started Guides** tab to create Markdown or HTML pages. These appear on the product's **Get Started** tab in the Live Portal and are the right place for tutorials, integration walkthroughs, and conceptual overviews.
66
68
67
69
6.**Save and verify**
68
70
69
71
Select **Save Changes**, then open the Live Portal and confirm:
70
72
71
-
1. The product appears in the assigned Catalog.
73
+
1. The Product appears in the assigned Catalog.
72
74
2. The **API specification** tab renders your uploaded specification.
73
75
3. No **Request Access** button is visible.
74
76
75
-
77
+
76
78
77
79
## What consumers see
78
80
79
-
Documentation-only products appear in the Catalog alongside regular products, but with key differences:
81
+
Documentation-only Products appear in the Catalog alongside regular Products, but with key differences:
80
82
81
-
1. The **Overview**, **API specification**, and **Get started** tabs are fully accessible.
83
+
1. The **Overview**, **API specification**, and **Get Started** tabs are fully accessible.
82
84
2. The interactive OpenAPI playground (Redoc or Stoplight) and GraphQL Playground are available for consumers to explore the schema and run queries.
83
85
84
86
85
87
86
88
3. There is no **Request Access** button.
87
-
4. There are no plans to select.
88
-
5. No credentials are issued.
89
+
4. There are no Plans available to select.
90
+
5. No credentials can be requested or issued.
89
91
90
-
This behavior is enforced by the Portal: the product has no associated access policy in Tyk Dashboard, and the UI hides all access-request components when a product is documentation-only.
92
+
This behavior is enforced by the Portal: the Product has no associated access policy in Tyk Dashboard, and the UI hides all access-request components when a Product is documentation-only.
91
93
92
94
## Convert between documentation-only and live products
93
95
94
-
You do not need to recreate a product to change its type. The Portal determines whether a product is documentation-only dynamically, based on whether any APIs are attached.
96
+
You do not need to recreate a Product to change its type: this is dynamic, based on whether any API access is configured.
95
97
96
-
**Convert a documentation-only product to a live product**
98
+
**Convert a documentation-only Product into a regular Product**
97
99
98
-
1. Open the product in the Admin Portal and navigate to the **APIs** tab.
99
-
2. Select a Provider, an authentication method, and one or more APIs.
100
+
1. Open the Product in the Admin Portal and navigate to the **APIs** tab.
101
+
2. Select a Provider, an authentication method, and one or more APIs to which the Product should grant access.
100
102
3. Select **Save Changes**.
101
103
102
-
The Portal creates a new access policy in Tyk Dashboard and the product becomes a live product. Consumers can now request access and receive credentials.
104
+
The Portal creates a new access policy in Tyk Dashboard so that it becomes a regular Product. Consumers can now request access and receive credentials to consume the APIs in the Product.
103
105
104
-
**Convert a live product to documentation-only**
106
+
**Convert a regular Product to documentation-only**
105
107
106
-
1. Open the product and navigate to the **APIs** tab.
108
+
1. Open the Product and navigate to the **APIs** tab.
107
109
2. Remove all selected APIs.
108
110
3. Select **Save Changes**.
109
111
110
112
<Warning>
111
-
When you convert a live product to documentation-only, the associated access policy in Tyk Dashboard is immediately deactivated. Any existing credentials issued for this product stop working at that point. If you re-add APIs later, the policy is reactivated and previously issued credentials resume working.
113
+
When you convert a regular Product to documentation-only, the associated access policy in Tyk Dashboard is immediately deactivated. Any existing credentials issued for this Product stop working at that point. If you re-add APIs later, the policy is reactivated and previously issued credentials resume working.
112
114
</Warning>
113
115
114
116
## Troubleshooting
@@ -117,14 +119,14 @@ When you convert a live product to documentation-only, the associated access pol
117
119
<Accordiontitle="Specification does not render on the API Specifications tab">
118
120
Check whether the Specification Alias contains a hyphen. If it does, rename the alias using underscores or camelCase, then re-upload the file.
119
121
</Accordion>
120
-
<Accordiontitle="Request Access button or plan selection is visible to consumers">
121
-
This was a bug in versions prior to v1.16.0. Upgrade to v1.16.0 or later. On older versions, the UI elements appear but are non-functional for documentation-only products.
122
+
<Accordiontitle="Request Access button or Plan selection is visible to consumers">
123
+
This was a bug in versions prior to v1.16.0. Upgrade to v1.16.0 or later. On older versions, the UI elements appear but are non-functional for documentation-only Products.
122
124
</Accordion>
123
-
<Accordiontitle="Error when adding APIs to convert a documentation-only product to live">
125
+
<Accordiontitle="Error when adding APIs to convert a documentation-only Product to live">
124
126
This was a bug in versions prior to v1.14.1. The Portal attempted to update a non-existent access policy. Upgrade to v1.14.1 or later to perform this conversion without errors.
125
127
</Accordion>
126
128
<Accordiontitle="Product is not visible in the Catalog">
127
-
Confirm the product is published to at least one Catalog, and that the consumer's Organisation has access to that Catalog. Documentation-only products follow the same Catalog visibility rules as regular products.
129
+
Confirm the Product is published to at least one Catalog, and that the consumer's Organisation has access to that Catalog. Documentation-only Products follow the same Catalog visibility rules as regular Products.
0 commit comments