API Management
13.2 13.1 13.0 12.2 12.1 12.0 11.0
API Management
13.2 13.1 13.0 12.2 12.1 12.0 11.0
Breadcrumbs

Signing up to Developer Portal

Developer Portal is the user-facing platform where developers can discover, test, and integrate APIs by communicating with the API Management Server.

This section illustrates how to sign up to the developer portal.

Login page

Use the URL below to go to the developer portal login page.

http://localhost:2020/
image-20250205-125857.png

Options available before signing in

Enabling the following options in the Customize > Options > Enable options for developers section in the developer portal admin allows the display options mentioned below for the public or anonymous users.

View public API products without signing in

If this option is enabled, products under all server groups for which “Public” is enabled for the Access option in the Products section of API Management Dashboard will be displayed for anonymous users (without signing up or signing in) in the developer portal.

image-20250218-071831.png
Enable API execution in swagger without signing in

Allows anonymous users to test and interact with APIs through Swagger UI.

Click the Explore image-20250218-072123.png icon next to the product name to go to the product screen. See the figure above.

Click the Try it out button and then the Execute button.

image-20250218-072745.png
image-20250218-072821.png

If disabled, the execute option won’t be available to the public.

Signing up

Prerequisite

Ensure that the email ID used to sign up is part of the domain set in the dev portal admin.

Registering with the developer portal

  1. Click the Sign up button on the upper-right part of the login page.

  2. Provide the Email ID that needs to be added as a developer/client.

  3. Click the Verify e-mail address button.

image-20250212-113701.png

A random verification code will be sent to the mail ID.

image-20250212-133221.png

Signing up to the Server Group

The page navigates automatically to the Signup page.

  1. Provide the following details:

    1. Email: Email ID that needs to be added as a developer/client.

    2. Verification Code: Use the verification code received in the mailbox.

    3. Password: Provide a password following the rules below:

      • One alphabetic character (A-Z or a-z).

      • One digit (0-9).

      • One special character (from the set @$!%*?&-_).

      • The length must be at least 8 characters.

    4. Server group: Provide the server group in which the applications need to be managed.

  2. Click the Sign up button.

image-20250212-115515.png

A confirmation mail will be sent to the registered email ID notifying the completion of the registration process.

image-20250212-132055.png

The user gets added under the Developers section in the dev portal admin.

Activating the user

By default, the developer status will be “Inactive”. Login is possible only after changing the status to Active.

image-20250217-104405.png
Invalid user error while trying to sign in

The added developer status needs to be changed from inactive to active in the Admin portal.

  1. Go to http://localhost:2020/admin/home/developers.

  2. Select the Server Group where signup was done.

  3. Click the Edit image-20250212-121334.png icon under the Status column of the new developer.

    image-20250212-121717.png

  4. Click the Active option and click the Save image-20250212-121232.png icon next to it.

    image-20250212-121903.png

The default value can be set to “Active” by enabling the Set developer status to ACTIVE upon creation automatically option in the developer portal admin.