- Request method: The HTTP method to use for the request, such as GET, POST, PUT, PATCH, and DELETE.
- URL: The URL of the API endpoint to send the request to.
- Request options: You can configure additional options for the request, such as headers, query parameters, and request body.
- Capture Response: You can capture the responses from the API and store them a variable. The response must be in JSON format.
Method and URL
In order to send a request, you must provide the endpoint URL and select the appropriate request method. The following request methods are supported:- GET: Retrieve data from the server.
- POST: Send data to the server.
- PUT: Update data on the server.
- PATCH: Partially update data on the server.
- DELETE: Delete data from the server.
https://openlibrary.org/works/OL45804W.json
Request Options
When sending requests to external APIs, you may need to provide additional options such as headers, query parameters, and request body. Here are the available options:- Headers: You can set headers for the request, such as Content-Type, Authorization, and Accept.
- Query Params: The URL query parameters to include for the request.
- Request Body: The request payload which can be passed as form data, form URL encoded, or raw JSON.
How to use variables in JSON payload
To use variables in the request payload, you must enclose the variable’s name in double curly braces within quotes. Here’s an example:- Make sure that the variables exist and that their name is correct. Otherwise, they will not be replaced with the actual value.
- If you change a variable’s name, you must also update the JSON payload to reflect the change.
- Variables must be enclosed in double curly braces as shown in the example above.
Capture Response
Responses from the API can be captured and stored in one or more variables. In order for this to work, the response from the endpoint must be in JSON format. Click theAdd
button to add a new row for capturing a value. You must specify the key and the variable where the value will be stored.
The naming convention for the key is as follows:
- Top level data: use the key, such as name or age.
- Nested data: use dot notation, such as user.name or profile.address.city.
- Array data: use the index, such as users[0].name or countries[1].cities[0].population.
- Title:
title
- Published date:
meta.published_at
- Author Name:
authors[0].author.name
