Open navigation

How can I configure my API offering using OpenAPI?

To make it easier to create API-based offerings, the platform allows you to configure settings by importing an OpenAPI file.


Using a file that respects OpenAPI (OAS 3) specifications pre-fills the required fields in the “Describe your API” section when setting up your offering. 


To use this method, all you have to do is import the file from your computer (in JSON format) or from a URL during the API configuration step: Add an offering > API > Describe your API.


After importing the file, you may check settings and add authentication information (if your API requires authorization).

Once all the parameters are configured, check to make sure everything works correctly using the “Test URL” section.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.