description |
---|
This page describes how to create and edit an application |
Unless the API has a keyless plan, a consumer must register an application and subscribe to a published API plan to access an API. Applications act on behalf of the user to request tokens, provide user identity information, and retrieve protected resources from remote services and APIs.
-
In the Developer Portal, click on Applications in the header
Create an app
-
On the General page, specify:
- Application name: Give your application a name (required)
- Description: Describe the purpose of your application (required)
- Domain used by the application: Enter the domain to be used by the application or keep the pre-filled default
- (Optional) Application Image: Select an image for your application
General application configuration
-
Select the appropriate tile to configure security for the type of software application you're registering your application for. Each application type requires you to set certain parameters.
{% tabs %} {% tab title="Simple" %} A Simple application is hands-free. With this application, you have the ability to define the client ID.
Parameters:
- Type: Enter the type of application (mobile, web, etc.).
- Client ID: Enter the client ID of the application. This field is required to subscribe to certain API plans (OAuth2, JWT).
Configure a Simple application
{% endtab %}{% tab title="SPA" %} A SPA, or single-page application (Angular, React, etc.), is a web application that performs the majority of the user interface logic in a web browser and uses web APIs to communicate with the web server.
Parameters:
- Toggle Authorization Code and Implicit to enable the types of rights authorized for the client. For security, define only the types you need.
- Use the + icon to add Redirect URIs where the authorization server will send OAuth responses.
Configure a SPA application
{% hint style="info" %} Until you add a Redirect URI, a red "x" will appear in lieu of the green checkmark above Security:
{% endhint %} {% endtab %}{% tab title="Web" %} A traditional Web application (Java, .Net, etc.) performs the majority of the application logic on the server.
Parameters:
- Toggle Authorization Code, Refresh Token, and Implicit (Hybrid) to enable the types of rights authorized for the client. For security, define only the types you need.
- Use the + icon to add Redirect URIs where the authorization server will send OAuth responses.
Configure a Web application
{% hint style="info" %} Once you add a Redirect URI, a green checkmark will appear in lieu of the red "x" above Security. {% endhint %} {% endtab %}
{% tab title="Native" %} A Native application (iOS, Android, etc.) can be installed directly on a mobile device.
Parameters:
- Toggle Authorization Code, Refresh Token, Resource Owner Password, and Implicit (Hybrid) to enable the types of rights authorized for the client. For security, define only the types you need.
- Use the + icon to add Redirect URIs where the authorization server will send OAuth responses.
Configure a Native application
{% hint style="info" %} Once you add a Redirect URI, a green checkmark will appear in lieu of the red "x" above Security. {% endhint %} {% endtab %}
{% tab title="Backend to backend" %} A Backend to backend application is machine to machine and does not require a user interface.
Parameters:
- Toggle Client Credentials to enable the types of rights authorized for the client. For security, define only the types you need.
Configure a Backend to backend application
{% endtab %} {% endtabs %}-
Use the search field to find an API for your application, then subscribe to it. Optionally, you can leave a comment for the API owner.
Subscribe to an API
-
Review the information you entered, then click CREATE THE APP:
{% hint style="success" %} You have successfully created an application! {% endhint %}
Once you've created an application, you can click on it and use the header options to review and edit the details of its configuration and usage:
-
General information: View and/or modify the application's configuration.
General information
-
Metadata: Enter a Name and Value and use the Format selector to define metadata for your application. Use the ADD and UPDATE buttons to modify your entries.
Metadata
-
Subscriptions: View the APIs your application is subscribed to. Use the API drop-down menu to choose a particular API and the status drop-down menu to list all APIs with the selected status.
Subscriptions
-
Members: View and edit member information:
-
MEMBERS LIST: View the names and roles of current application members.
Members list
-
ADD A MEMBER: Use the search field to add a member to the application and assign that member a role.
Add a member
-
TRANSFER OWNERSHIP: Transfer ownership of the application to another user and select a different role for the current primary owner.
Transfer ownership
-
INHERITED MEMBERS: View the names and roles of members inherited from other groups.
Inherited members
-
-
Analytics: Use the available filters to refine the application logs. Scroll down to view other metrics related to the application (top paths, top APIs, response times, etc.).
Analytics
-
Logs: Use the available filters to view and optionally export refined application analytics. Scroll down to view the logs.
Logs
-
Notifications: Specify which of your application's subscription events you would like to be notified of.
Notifications
-
Alerts: Use the fields and drop-down menus to define an alert. After you ADD AN ALERT, it will appear in the ALERTS LIST. Application members will be notified via email.
Alerts