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
Copy file name to clipboardExpand all lines: tyk-docs/content/basic-config-and-security/reduce-latency/caching/advanced-cache.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ For details on the API-level cache you should refer to the [API-level cache]({{<
16
16
When your API has more than one endpoint the upstream data could have different degrees of freshness, for example the data returned by one endpoint might refresh only once every five minutes (and so should be suitably cached) whilst another might give real-time data and so should not be cached. The endpoint cache allows you to optimize the caching of each endpoint to meet your requirements.
17
17
18
18
#### Request based caching
19
-
If you have an API that's providing search capability (for example into a catalogue of products) and want to optimize the performance for the most frequently requested search terms, you could use the endpoint cache's [request-selective](#request-selective-cache-control) capability to cache only a subset of all requests to an endpoint.
19
+
If you have an API that's providing search capability (for example into a catalog of products) and want to optimize the performance for the most frequently requested search terms, you could use the endpoint cache's [request-selective](#request-selective-cache-control) capability to cache only a subset of all requests to an endpoint.
20
20
21
21
## How the endpoint cache works
22
22
If caching is enabled then, by default, Tyk will create separate cache entries for every endpoint (path) of your API. This may be unnecessary for your particular API, so Tyk provides a facility to cache only specific endpoint(s).
Copy file name to clipboardExpand all lines: tyk-docs/content/basic-config-and-security/security/mutual-tls/client-mtls.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -63,7 +63,7 @@ $ curl -k \
63
63
Instead of manually creating keys, we can expose the Above API via the Developer Portal, where developers can add their own certs to use to access APIs.
64
64
65
65
1. Create a policy for the API we set up above
66
-
2. Create a catalogue entry for this policy
66
+
2. Create a catalog entry for this policy
67
67
3. As a developer on the Portal, request a key for this API. This will take us to this screen:
Copy file name to clipboardExpand all lines: tyk-docs/content/basic-config-and-security/security/owasp-top-ten.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -109,7 +109,7 @@ Tyk offers the following features to support improper inventory management:
109
109
-[Versioning]({{< ref "getting-started/key-concepts/versioning" >}}) allows newer versions of APIs to coexist with the older versions, facilitating deprecation and sunsetting.
110
110
-[Sunsetting]({{< ref "getting-started/key-concepts/versioning#sunsetting-api-versions" >}}) allows versions to be configured with an Expiry Time, ensuring that a version is not accessible after the expiry date.
111
111
-[Key expiry]({{< ref "basic-config-and-security/control-limit-traffic/key-expiry" >}}) ensures that access to an API is short lived, with a per key configurable Time to Live (TTL) for which a token remains valid before it expires. The implementation of key expiry, with a configurable Time To Live (TTL), mitigates the impact of compromised tokens by narrowing the window of vulnerability. Setting a TTL reduces the time frame during which a compromised token could be exploited, enhancing overall security.
112
-
- Tyk Developer Portal catalogues APIs and facilitates granting access to them. Integrated with a CMDB it can help keep documentation updated.
112
+
- Tyk Developer Portal catalogs APIs and facilitates granting access to them. Integrated with a CMDB it can help keep documentation updated.
113
113
-[Tyk Analytics]({{< ref "tyk-dashboard-analytics" >}}) can help identify the stagnant APIs and used stale APIs.
114
114
-[Tyk Pump]({{< ref "tyk-pump" >}}) can ship metrics needed for analytics into Tyk Dashboard and other systems.
115
115
- Third-party [Secret Storage]({{< ref "tyk-configuration-reference/kv-store" >}}) can be used to centralise and protect sensitive configuration data such as passwords, rather than exposing them as plain text in Tyk configuration files.
Copy file name to clipboardExpand all lines: tyk-docs/content/planning-for-production/database-settings/postgresql.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ How you configure your PostgreSQL installation depends on whether you are instal
21
21
22
22
## Migrating from an existing MongoDB instance
23
23
24
-
For v4.0 we have provided a migration command that will help you migrate all data from the main storage layer (APIs, Policies, Users, UserGroups, Webhooks, Certificates, Portal Settings, Portal Catalogues, Portal Pages, Portal CSS etc.).
24
+
For v4.0 we have provided a migration command that will help you migrate all data from the main storage layer (APIs, Policies, Users, UserGroups, Webhooks, Certificates, Portal Settings, Portal Catalogs, Portal Pages, Portal CSS etc.).
For this release multiple policies are only supported only via the Add Key section and via the API. Support for OIDC, oAuth, and Portal API Catalogues are planned for subsequent releases.
36
+
For this release multiple policies are only supported only via the Add Key section and via the API. Support for OIDC, oAuth, and Portal API Catalogs are planned for subsequent releases.
Copy file name to clipboardExpand all lines: tyk-docs/content/product-stack/tyk-dashboard/release-notes/archived-releases/version-2.6.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -346,11 +346,11 @@ admin-auth: 12345
346
346
}
347
347
```
348
348
349
-
#### Set Catalogue settings for each individual API
349
+
#### Set Catalog settings for each individual API
350
350
351
-
Now you can override the global catalogue settings and specify settings per catalogue.
352
-
The Catalogue object now has `config` field, with exactly same structure as Portal Config, except new `override` boolean field.
353
-
If set, Catalogue settings will override global ones.
351
+
Now you can override the global catalog settings and specify settings per catalog.
352
+
The Catalog object now has `config` field, with exactly same structure as Portal Config, except new `override` boolean field.
353
+
If set, Catalog settings will override global ones.
354
354
355
355
At the moment the following options can be overriden: `Key request fields`, `Require key approval` and `Redirect on key request` (with `Redirect to` option as well).
Copy file name to clipboardExpand all lines: tyk-docs/content/product-stack/tyk-dashboard/release-notes/archived-releases/version-2.9.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -23,15 +23,15 @@ Additionally you can now mix policies defined for the same API but having differ
23
23
24
24
#### Developer Portal Updates
25
25
26
-
Developers now can have multiple API keys, and subscribe to multiple catalogues with a single key. Go to the Portal settings and set `Enable subscribing to multiple APIs with single key` option to enable this new flow. When enabled, developers will see the new API generation user interface, which allows users to request access to multiple Catalogues of the **same type** with a single key.
26
+
Developers now can have multiple API keys, and subscribe to multiple catalogues with a single key. Go to the Portal settings and set `Enable subscribing to multiple APIs with single key` option to enable this new flow. When enabled, developers will see the new API generation user interface, which allows users to request access to multiple Catalogs of the **same type** with a single key.
27
27
28
28
From an implementation point of view, Developer objects now have a `Keys` attribute, which is the map where the key is a `key` and the value is an array of policy IDs. The `Subscriptions` field can be considered as deprecated, with retained backwards compatibility. We have added new set of Developer APIs to manage the keys, similar to the deprecated subscriptions APIs.
29
29
30
30
Other changes:
31
31
32
32
- Added two new Portal templates, which are used by a new key request flow `portal/templates/request_multi_key.html`, `portal/templates/request_multi_key_success.html`
33
-
- The Portal Catalogue list page has been updated to show the Catalogue authentication mode
34
-
- The API dashboard screen now show keys instead of subscriptions, and if subscribed to multiple policies, it will show the allowance rules for all catalogues.
33
+
- The Portal Catalog list page has been updated to show the Catalog authentication mode
34
+
- The API dashboard screen now show keys instead of subscriptions, and if subscribed to multiple policies, it will show the allowance rules for all catalogs.
35
35
- The Key request API has been updated to accept an `apply_policies` array instead of `for_plan`
description: "Segment your developer audience with catalogs and organisations"
6
6
menu:
7
7
main:
8
8
parent: "Manage API Users"
@@ -18,7 +18,7 @@ If you are interested in getting access, contact us at [[email protected]](<mailto:
18
18
19
19
## Introduction
20
20
21
-
In the Tyk Enterprise Developer Portal, Organisations and Catalogues are used to segment the user base and make different APIs available to different user audiences according to the business model.
21
+
In the Tyk Enterprise Developer Portal, Organisations and Catalogs are used to segment the user base and make different APIs available to different user audiences according to the business model.
22
22
For example, assume the following scenario:
23
23
24
24
- Account Management API is available only to trusted partners
@@ -29,11 +29,11 @@ Subsequently, two catalogs can be created for these two APIs.
29
29
In the below example, an API Provider offers two API Products (the Accounts API and Payment API) with two plans (the Free plan and Enterprise plan) to their customers.
30
30
Customers subscribed to the enterprise plan can use both APIs, offering a higher user limit. Conversely, customers subscribed to the Free plan (individual developers or hobbyists) only have visibility of the Payment API.
31
31
32
-
To achieve that, the API Provider uses two catalogues to implement their business model so that they can offer different experiences for different customer audiences. This section explains how to achieve that using the Tyk Enterprise Developer Portal.
32
+
To achieve that, the API Provider uses two catalogs to implement their business model so that they can offer different experiences for different customer audiences. This section explains how to achieve that using the Tyk Enterprise Developer Portal.
33
33
{{< img src="/img/dashboard/portal-management/enterprise-portal/org-catalogue-product-relation.png" alt="Relationship between catalogues, API Products, plans, teams, and organisations" >}}
34
34
35
35
## Create organisation and teams
36
-
The Tyk Enterprise Developer Portal uses Organisation and Catalogues to segment access to APIs and plans. Therefore, the first thing is to create an organisation for your customers. If you don't want to provision organisations manually, you can leverage the [Admin APIs]({{< ref "/product-stack/tyk-enterprise-developer-portal/api-documentation/tyk-edp-api.md" >}}) or enable the [self-service organisation registration]({{< ref "/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/manage-api-consumer-organisations.md" >}}).
36
+
The Tyk Enterprise Developer Portal uses Organisation and Catalogs to segment access to APIs and plans. Therefore, the first thing is to create an organisation for your customers. If you don't want to provision organisations manually, you can leverage the [Admin APIs]({{< ref "/product-stack/tyk-enterprise-developer-portal/api-documentation/tyk-edp-api.md" >}}) or enable the [self-service organisation registration]({{< ref "/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/manage-api-consumer-organisations.md" >}}).
37
37
In this guide, we will create the **B2B customer** organisation to fulfill the above business model:
38
38
1. To create an organisation for the **B2B customer**, navigate to the **Organisations** menu and click on the **Add new organisation** button.
39
39
{{< img src="/img/dashboard/portal-management/enterprise-portal/navigate-to-organisations.png" alt="Navigate to the Organisations menu" >}}
@@ -48,38 +48,38 @@ You can edit the default team name by navigating to **Teams** and opening up the
48
48
49
49
{{< /note >}}
50
50
51
-
## Create catalogues
52
-
1. To create catalogues, navigate to the catalogues menu in the Tyk Enterprise Developer Portal.
51
+
## Create catalogs
52
+
1. To create catalogs, navigate to the catalogs menu in the Tyk Enterprise Developer Portal.
53
53
54
-
The default catalogues that are featured when the portal is [bootstrapped]({{< ref "/product-stack/tyk-enterprise-developer-portal/deploy/bootstrapping-portal.md" >}}) are:
55
-
-**Public**catalogues are available to all developers.
56
-
-**Private**catalogues are available only to logged in developers who have been assigned with access.
54
+
The default catalogs that are featured when the portal is [bootstrapped]({{< ref "/product-stack/tyk-enterprise-developer-portal/deploy/bootstrapping-portal.md" >}}) are:
55
+
-**Public**catalogs are available to all developers.
56
+
-**Private**catalogs are available only to logged in developers who have been assigned with access.
57
57
58
-
You can create new catalogues by clicking on the **Add new catalogue** button or use the default catalogues.
58
+
You can create new catalogs by clicking on the **Add new catalog** button or use the default catalogs.
59
59
60
60
{{< img src="/img/dashboard/portal-management/enterprise-portal/navigate-to-catalogues.png" alt="Navigate the to catalogues menu" >}}
61
61
62
-
2. To add a new catalog, click on the **Add new catalogue** button. Then specify the name of the catalog and select its type: **Private** or **Public**.
63
-
Since the public catalogue already exists, in this guide you need to create only an additional private catalogue called **Enterprise catalogue** for the **B2B customer** who will have extended access rights compared to other developers.
62
+
2. To add a new catalog, click on the **Add new catalog** button. Then specify the name of the catalog and select its type: **Private** or **Public**.
63
+
Since the public catalog already exists, in this guide you need to create only an additional private catalog called **Enterprise catalog** for the **B2B customer** who will have extended access rights compared to other developers.
64
64
{{< img src="/img/dashboard/portal-management/enterprise-portal/specify-name-of-catalogue.png" alt="Create a catalogue" >}}
65
65
66
66
{{< note >}}
67
67
**Note**
68
68
69
-
While it is possible to create multiple public catalogues, we do not advise doing so. This is because multiple public catalogues will share the same level of access.
69
+
While it is possible to create multiple public catalogs, we do not advise doing so. This is because multiple public catalogs will share the same level of access.
70
70
{{< /note >}}
71
71
72
-
3. Once the catalogue is created, add a developer audience to it by clicking on the **Add Team** button and selecting an appropriate developer team (**B2B customer All users** in this example).
73
-
Finally, add plans and API Products to the created catalogue so that the selected developer teams can view them.
72
+
3. Once the catalog is created, add a developer audience to it by clicking on the **Add Team** button and selecting an appropriate developer team (**B2B customer All users** in this example).
73
+
Finally, add plans and API Products to the created catalog so that the selected developer teams can view them.
74
74
{{< img src="/img/dashboard/portal-management/enterprise-portal/add-team-products-and-plans.png" alt="Add teams, products, and plans to the catalogue" >}}
75
75
76
-
You can achieve the same result by navigating to the **API Products** menu. Adding an API Product to a catalogue through the **Catalogues** and the **API Products** menus will produce the same result.
76
+
You can achieve the same result by navigating to the **API Products** menu. Adding an API Product to a catalogue through the **Catalogs** and the **API Products** menus will produce the same result.
77
77
{{< img src="/img/dashboard/portal-management/enterprise-portal/publish-products-to-catalogues.png" alt="Adding a product to a catalogue through the API Products menu" >}}
78
78
79
79
{{< note >}}
80
80
**Congratulations**
81
81
82
-
You have successfully added a catalogue and associated a team with it. Furthermore, you have allocated plans and API products to this catalogue.
82
+
You have successfully added a catalog and associated a team with it. Furthermore, you have allocated plans and API products to this catalog.
83
83
{{< /note >}}
84
84
85
85
Visit [Customise the sign-up form]({{< ref "/product-stack/tyk-enterprise-developer-portal/getting-started/customize-sign-up-form" >}}) for the user sign-up form customisation guide.
0 commit comments