1. Home
  2. Knowledge Base
  3. FAQs
  4. How do I create an API in OutSystems?

How do I create an API in OutSystems?

There are 2 ways of creating an API in Outsystems: the traditional way by creating one from scratch and the no-code way by leveraging Hubway Connect.

The traditional way

If you choose to create an API from scratch, you can use OutSystems’ built-in connectors, automation, and centralised management of integrations to simplify the process.

Here are the steps to create an API from scratch in Service Studio:

  • Open Service Studio and the module in which you want to create the integration..
  • In the logic tab, open the Integration folder.
  • Right click on REST /SOAP and create a new REST API / SOAP Web Service.

Expose REST API - Hubway Connect

  • Define the API’s input and output parameters.
  • Define the API’s methods and their respective actions.

add rest api method

  • Publish the API.

For more information check out OutSystems documentation.

The no-code way or how to create a fully functional API in less than a minute!

Launch the Hubway Builder and create a new project.

Enter a project name in the friendly name field. The service name will be auto-generated, and you can choose to modify the service name if required.

create a fully functional api in less than a minute - hubway connect

Navigate to the Entities tab of the Project. Search for OrderManagement. This will display all the OutSystems entities within the Order Management module in the left pane.

Tick the checkbox next to the following entities: Order, OrderItem, Product, ProductCategory and OrderStatus. Then click Add selected.

entities checklist

Alternatively, you can also click the (+) icon on the right side of each entity and add them one by one. This will add the entities to the Exposed Entities section on the right pane.

Exposed Entities

For this demo, you can leave the security settings as default and allow the service to be accessible to any valid user account.

Click the Publish button. This will generate the service endpoint URL. This out-of-the-box APIs will offer sorting, filtering, etc.



Was this article helpful?

Related Articles