1.Tutorial: Create a portal entry
Using the dashboard to create a portal catalogue entry is very quick with a few prerequisites.
Prerequisites for a portal catalogue entry:
- An API configured and live on your gateway
- The API must be Closed (i.e. it must use either Auth Token or Basic Auth security mechanisms)
- A security policy configured to grant access to the API
Step 1: Select “Catalogue” from the “Portal Management” section
This page displays your existing catalogue APIs and whether they have documentation created and are active or not.
Step 2: Click Add new API
Step 3: Enter a Public API name and associate a security policy
When publishing an API with Tyk, you are not publishing a single API, but instead you are publishing access to a group of APIs. The reason for this is to ensure that it is possible to compose and bundle APIs that are managed into APIs that are published. Tyk treats these as separate, so the thing that is published on the portal is not the same as the actual API being managed by Tyk, one is a logical managed API and the other (the published catalogue version) is a facade.
Since API policies allow the bundling of access control lists of multiple APIs, it is this that you are granting access to. Any developer that signs up for this API will be granted a bearer token that has this policy as a baseline template, or as a “plan”.
- You will only see security policies for valid APIs in the drop-down list for the policies
- The policy must be “closed” (see the requirements above)
Step 4: Add description
All catalogue entries can have a description, these fields support markdown for formatting:
Step 5: Enable the API
An API will not be published until you mark it as active, make sure the check-box is
checked, otherwise the API entry will not appear:
Step 6: Save the API
You’ll notice that you haven’t added any docs yet, that’s ok for now – you can always add these after you have created the API (in fact, you need to create the entry first before you can attach docs).
To save the API, click the
Step 7: Take a look
You can now visit your portal to see the API catalogue entry, to do so, simply select the option from the top-nav: