Awaiting product image

Tyk Dev Portal

€0

If you are using the Tyk API Gateway and have a WordPress site you can use this plugin to integrate a developer portal into your site. This is handy when your API requires a complementa

Version

1.0.0
Last updated

2016.10.16
Active installations

10
WordPress Version

4.6
Tested up to

4.6.27
pa_tag

api
Rating

0.00
Total ratings

0
This plugin is outdated and might not be supported anymore.
Go back
View on WordPress site

Description

If you are using the Tyk API Gateway and have a WordPress site you can use this plugin to integrate a developer portal into your site. This is handy when your API requires a complementary website with information e.g. about the service and you want the developer portal in the same place. It’s main goal is to offer developer sign up and obtaining access tokens from your WordPress site.

This plugin is a work in progress and currently offers the following features:

  • automatic developer registration on Tyk when developers sign up in WordPress
  • configuration of API policies available for token registration
  • developers may request an access token for the available API policies
  • automatic or manual approval of key requests
  • storage of token (references) by name and API policy
  • revoking of tokens by developer

What this plugin does not offer:

  • Management of Tyk API Gateway (the Tyk Dashboard is best suited for that)
  • WordPress user registration (there are enough plugins that do that quite well)

Support

Please note that we, the plugin authors, cannot offer support for this plugin. The code is on GitHub however and we are happy to accept pull requests fixing bugs or adding functionality. Also feel free to report any issues although we cannot promise when and if they will be fixed.

Todos

The following changes are in planning:

  • use catalogues on Tyk portal to group policies instead of tags
  • make chart colors configurable
  • split up template and dashboard.js into multiple components
  • build js to vendor/ dir
  • ~~refactor dashboard a bit considering that there can’t be more than 1 token per API anyway~~
  • ~~add option to not include bootstrap altogether~~
  • ~~do not allow registering for multiple API policies (as it’s not supported by Tyk)~~

Further reading

Automatic key approval

When TYK_AUTO_APPROVE_KEY_REQUESTS is set to true in wp-config.php, key requests will be approved automatically by this plugin. That means a developer will request an access token on the Dashboard page of your WordPress (where this plugin is running) and they will be processed automatically. For this to work, make sure Require key approval is not active in your Tyk Dashboard at Portal Management > Settings.

If you wish to approve key requests manually, set TYK_AUTO_APPROVE_KEY_REQUESTS to false and activate Require key approval mentioned above. When a developer requests an access token, he will get a message with his key request ID. The further process is up to you. Key requests can be approved in the Tyk Dashboard at Portal Management > Key Requests. You could configure an email to be sent out in the Portal Management Settings or do it manually.

Custom dashboard page

The developer dashboard will be displayed in the same layout as your other pages. If you wish to further customize the page, you can create a custom page template and embed the dashboard by using this template tag: <?php tyk_dev_portal_dashboard()?>.

Styling

You may need to fix some styles as this plugin includes a subset of the bootstrap styles with it and the styles of your theme may conflict with some of them. Bootstrap is only included when your theme doesn’t already include it. You can set TYK_FORCE_DISABLE_BOOTSTRAP to true to force disable the bootstrap styles in case you need to.

i18n

This plugin is ready for translation and currently supports the following languages:
* German
* French
* Italian