Table of Contents |
---|
The default link to the developer portal after starting is https://localhost:4843/. This can of course be changed to match your preference in the launcher configuration.
...
After opening and logging into the developer portal you will be presented by the front screen.
Logging in is done through the link in the top right corner which will present a login dialog with the possibility to register as a new user and reset an existing password.
Self-Registration can be done like this:
After logging in or registering (might be a two-step process including a confirmation email) you will be shown the front page of the developer portal.
Here you have a standard layout with the content on the right and a menu with access to required functions on the left.
...
If you need to create a partner - click on the "Create partner" button at the top, and a dialog will be shown where you can fill in name, description and your contact information (for administrators if needed). You can also add other developers to this partner and assign them a role as owner or read only.
On the partner list you will have access to editing and deleting a partner if you are owner off - if you only have read only access to that partner you can only view details - but you might be able to work on the applications defined on this partner, depending on your role on that particular application.
You can double click on a partner "card" or click on the link to the defined applications to see the applications on that particular partner. That will bring you to the "Partner applications" screen.
...
After choosing a partner on the Partner screen - you will be able to see the applications for the chosen partner. If you click on the menu link "Partner applications" and you only have one partner assigned to you - this partner will be chosen as default. The chosen partner can be seen at the top of the "Partner applications" screen.
The button "Create application" will be available to you if you are the owner of the chosen partner. If you have a read only role for the chosen partner, you will not be able to create new applications for the partner.
...
If Elasticsearch is enabled for the developer portal - an additional tab called "API Usage" will be shown giving access to API call count and response times for each API called form the application.
My Applications
Going into "My application" will be the standard place for a developer. Here you will see all the applications you are assigned to as a developer - you can filter on the role if needed.
The functionality on this screen in regards to the individual applications is the same as that on "Partner applications".
...
If you can see an API here - you can subscribe to it by clicking the "subscribe" button on the left. By clicking the subscribe button to the left you can choose which subscription plan you would like to subscribe with. These choices are made available through the API definition.
After subscribing to an API you will be able to try the API (currently only open API versions).
By clicking "Try API" on the right the swagger API for this API will open, the API key and client secret from the application will be set and you will be able to call the API and test it out.
...
If the API Developer has written any documentation for an API, you can click on the action to view it.
Profile and Sign Out
The last two menu items allows you to change your profile information, including your password, as well as deleting your developer profile from the system. If you delete the developer profile from the system you will not be able to manually create a developer again, as your email will be stored in the system as deleted - until an administrator removes it completely.