Developer Portal (trial)

🚧

The Developer Portal is in Beta Trial

Throughout Q1, support for this service is limited and not recommended for production usage. The beta trial is expected to end in Q1 2022.

The Developer Portal provides a set of resources that allow you to discover and manage access to Shogun's APIs. In the Developer Portal, you can:

  • Browse a catalog of available services
  • Register for access to a service
  • Generate API keys to authenticate with a service
  • Access API documentation to learn how to use the service

Follow these steps to get started with the API Developer Portal:

  1. Create a developer portal account.
  2. Log in to the developer portal.
  3. Create a service application.
  4. Generate an API key.

Creating a Developer Portal Account

In this scenario, you register for a Shogun Developer Portal account and confirm the account registration. Once the account registration is confirmed - and Shogun has approved your account - you can use it to log in to the Developer Portal.

  1. Navigate to the Developer Portal login page:
    https://shogun50eddae8.portal.konnect.konghq.com/login
  1. Click "Sign up →".
  2. Complete the registration form and select "Create Account".

The account creation request is submitted, and a confirmation message is displayed.

  1. In your email account, find the confirmation email. Select the "Confirm your email" to complete the registration.

The account confirmation completes, and you get the following message. Click "Okay."

🚧

After creating your account, you will not be able to log in to the Developer Portal until Shogun approves your account. Account approval should take less than 24 hours. If not approved in 24 hours, contact [email protected].

Logging in to the Developer Portal

🚧

You will not be able to log in to the Developer Portal until Shogun approves your account.

In this scenario, you use your approved account to log in to the Developer Portal.

  1. Navigate to the Developer Portal login page:
    https://shogun50eddae8.portal.konnect.konghq.com/login
  2. Enter the email address and password of your Developer Portal account. Select "Login."

The login succeeds. The authorized services for your account are listed under "Services."

Creating a Service Application

In this scenario, you register for access to a service. You select a service from the list of services authorized for your account, create and register an application for the service, and request access to it.

  1. In the Developer Portal, select CMS under Services.
  1. Select "Register".
  1. Select "Create Another Application".
  1. In the Create New Application form, enter an Application name. For example, "a CMS API application." Enter a Reference ID and Description for the application, and select "Create."
  1. In the Register for CMS dialog, select your application from the dropdown menu and click "Request Access."

The registration request is approved. You now have an interface - your registered application - to manage API credentials for the CMS API service.

Generating an API Key

In this scenario, you create credentials that authorize access to the CMS API. You navigate to the application registered for the service and generate an API key.

  1. In the Developer Portal, navigate to My Apps in the top right corner.
  1. Select your registered application by clicking on "my CMS API application."
  1. Select "Generate Credential."

An API key is generated. The API Key authorizes access to the CMS API.


Did this page help you?