Application registration#

This section will explain how to register an application to the MarketPlace platform. To create your own, refer to the get started app.

1. Create a knowledge item#

All interconnected elements in the platform are represented by knowledge items. Apps being one of those elements, the first step will be creating the corresponding item.

First, click on the “Create” option of the navigation bar and select the “App” item.

Create knowledge item page

Next, define the name of your application, confirm that you have the rights to register such an application, and click on “Create item”.

Create app item

You will be redirected to the knowledge item admin page. Here you can set the logo, a summary, metadata for classifying the application and connections to other knowledge items. To proceed to the next step, click on “Dashboard”.

App page

2. Register application#

In the Register section of Admin console you can provide the necessary information about the application. Here you can also define app dependency by choosing the app type.

The callback address and scopes are needed for integrating authentication via the MarketPlace in your app.

You must also upload the file with the openAPI specification. For more information on this file, refer to the OpenAPI specification section.

Registration input

If the registration process is successful, you will be provided with some meaningful information for your application.

Registration output

In the case that you have developed the application following a setup similar to the aforementioned get-started app, the client_id and client_secret should be used when you start your application server to enable the Single Sing On mechanism via the MarketPlace platform.

Attention

For security reasons, the client_secret will not be shown again. Store it somewhere safe if you intend to use it in the future.

Next, a platform admin should approve the registration. In the meantime, make sure that your application server is running and can be reached.

Once the application has been approved, the application information should be available in the Summary.

Application Dashboard

To be able to use the application, one of the products should be purchased on the Pricing plans section.

Purchasing a product

3. Test application#

You can directly test the communication with the newly registered application via MarketPlace on the Swagger viewer. The endpoints shown there are directly generated based on the uploaded openAPI file.

Swagger view

More information on swagger is available in the official swagger documentation.

Important

When communicating with the registered application via the MarketPlace, the query and path parameters of your application endpoint should all be sent as query parameters.

Example 1
Application endpoint:
https://my-app.com/simulations/4f384c28-8671-4c7d-a6cf-22d127fc0866
MarketPlace endpoint:
https://www.materials-marketplace.eu/api/applications/proxy/<CLIENT_ID>/getTransformation?transformationId=4f384c28-8671-4c7d-a6cf-22d127fc0866

Example 2
Application endpoint:
https://my-app.com/simulations?transformationId=4f384c28-8671-4c7d-a6cf-22d127fc0866
MarketPlace endpoint:
https://www.materials-marketplace.eu/api/applications/proxy/<CLIENT_ID>/getTransformation?transformationId=4f384c28-8671-4c7d-a6cf-22d127fc0866