Skip to main content
Version: 12.x (Current)

Requests Form Configuration

Once you successfully create the Dev Portal application, you should be able to send requests from any API or event on the marketplace and receive them in the backoffice section.

However, depending on your needs, the CRUD data model required for these requests may vary significantly.

For instance, in certain scenarios it may be necessary to ask users requesting the API to include their own RSA public key, while others may not require this type of information.

info

Different applications of the dev portal may lead to different requests data models, hence different requests form implementations.

Request Form Types

For the aforementioned reasons, we propose two out of the box solutions to implement your requests:

  • Base Form;
  • Client Credentials Form.

By default, requests are configured to implement the client credentials form.

Base Form

The base form includes all the basic information needed to specify a request:

  • Email;
  • Name;
  • Status;
  • Organization;
  • Requested Component.

Please note this data model is a subset of the one specified in the backoffice section documentation.

Here is a preview of how this type of form will look like:

base form

Client Credentials Form

This type of form takes its name from the microservice handling the corresponding data model. You can have further details regarding the client credentials in the dedicated documentation section

It includes all the basic information specified in the base form while adding the public key additional property:

  • Email;
  • Name;
  • Status;
  • Organization;
  • Requested Component;
  • Public Key.

This data model matches the one specified in the backoffice section documentation.

Here is a preview on how this type of form will look like:

client credentials form

Switch Form Configuration

As mentioned before, the client credentials form will be considered as the default implementation in the dev portal application.

In case you need to change this default behavior, you can disable the use of the public key by editing the dev-portal-frontend configuration. Move to the config.json file and search for the marketplace application:

{
"integrationMode": "parcel",
"route": "/dev-portal/marketplace/",
"entry": "/dev-portal-marketplace/",
"injectBase": true,
"properties": {
"formKind": "clientCredentials"
}
}

Inside the properties object update the formKind field with one of these options:

  • base;
  • clientCredentials.

Type base if you wish to switch to the base form and vice versa.