How to create an oData API in the API Builder

If you require to create an oData API type in the API Builder, you need to do the following steps:

1. Regenerate the API Key for your org by clicking on the menu and then clicking on Settings as highlighted in the image below to go to your org’s settings.

image

The below tab will appear. Click on the “Regenerate Api Key” button and then click “Ok” to confirm.

The below page will appear with a new API Key. Copy the API Key by clicking on the icon circled in red and paste it to a safe place. The API Key will be used later on for the login credentials if you require to send the data to a reporting tool such as Power BI.

2. Create a user group by going to the menu and click on User Groups as highlighted in the below image.

image

Click on “Add Group” to add a group and then type a group name. To add a user to the group, click on the Add User button and then click on the highlighted down arrow icon as shown in the image below to select the user’s email address. Once the users are added to the group, click on Save. This group of users will have access to the API.

NB: When adding a new user to a group, the user has to be a user that is on the org.

3. To create an oData API, click on the 3 dots circled in red next to the API Builder section and click on “Create API” as illustrated below.

image

The below page will appear. Type a name for the API and then click on the highlighted down arrow for the drop down list to open and select “oData” as the API type. Then click on Save.

4. Configure the oData API settings by going to the page from the API Builder section. Click on the Info section and then click on “Add User Group” in the Security Groups field. Type the group name that you created earlier and then click on Save.

Click on the highlighted icon to add an Entity and then click on the Source tab to select or create a buffer as your source data.

Click on the Model tab and click on the highlighted icon to create each model as illustrated in the image below. The models will be the field names from the source buffer that was selected in the Source tab.

Click on the Definition tab and populate the Title field and then click on Save as shown in the image below.

The URL path that will be used in the HTTP Service steps will be the URL in the Entity Path field as circled in red in the below image. Click on the highlighted icon in the below image to copy the URL to use.