API Requests
You can add API requests to the Loome Portal.
In the left-hand navigation menu, click on Developers.
How to Add an API Request
On the API Requests page, click on Add API Request at the top-right of the page.
Provide the name for the API request.
For the URL, choose from:
- GET
- POST
- PUT
- PATCH
- DELETE
Then provide the URL to make your request.
You can make the URL dynamic by using tokens in the {{variable_name}} format. These placeholders will be replaced with actual data when the request is sent.
Additionally, you can use the token ‘{{upn}}’ if you would like the current user UPN injected at the time of running the request. You can also use the {{upn}} token in the following three sections.
API Request Parameters
In the ‘Params’ section, you can add any query strings (or you can add it in the URL directly).
Provide a Query string name and query string value, and then click +.
API Request Headers
In the ‘Headers’ section, you can add any headers that need to be present on the outgoing http request.
Both header names and values support dynamic tokens in the {{variable_name}} format.
Provide a Header name and Header value, and then click +.
API Request Body
In the ‘Body’ section, you can add key value pairs and body data that will be sent in the body of the request.
Types: application/x-www-form-urlencoded
Add any key value pairs here that need to be present in the body of the request.
Provide a Key and Value and then click +.
Both the key and value field support dynamic tokens in the {{variable_name}} format.
Types: application/json, application/xml, text/plain, text/xml
If you require body data to be sent in your request, you can provide it in the body field.
Tokens can be used in the body in the {{variable_name}} format.
Save the API Request
After you have completed these fields, click on Save at the top-right of the page.
You can view added API requests with the method and URL in the API request table.
You can run a test run, edit and delete the API Request in the actions column on the right of the API Request.
