Skip to content
Nappai Documentation

API Request

This component in Nappai acts as a messenger, sending requests to websites and receiving data in return. It’s useful for automating tasks that involve fetching information from online services.

Relationship with HTTP APIs

This component interacts directly with websites and online services using HTTP requests (GET, POST, PUT, PATCH). Think of it as a way to talk to different online services using a common language.

Inputs

  • URLs: Enter one or more website addresses (URLs) separated by commas. This tells the component where to send the request. For example: https://api.example.com, https://anotherapi.com
  • Curl: Paste a curl command (a way to describe HTTP requests) here. This will automatically fill in the Headers and Body fields for you. A button is available to update the fields.
  • Method: Choose the type of request: GET (to retrieve data), POST (to send data), PATCH (to update data partially), or PUT (to replace data completely). The default is GET.
  • Headers: These are additional instructions sent with your request. They are usually technical details, but the Curl input can help you fill this in automatically.
  • Body: This is the data you send with your request (used for POST, PATCH, and PUT methods). The Curl input can help you fill this in automatically.
  • Query Parameters: Add extra information to your URL to refine your request. This is like adding filters to your search. For example, {"page": 1, "limit": 10}.
  • Timeout: Set how long (in seconds) the component should wait for a response before giving up. The default is 5 seconds.

Outputs

The component produces a list of “Data” objects. Each object contains the results of an HTTP request, including:

  • Source: The URL you requested.
  • Headers: The response headers from the website.
  • Status Code: A number indicating whether the request was successful (e.g., 200 means success).
  • Result: The actual data received from the website. This will often be in JSON format.

You can use this output data in other parts of your Nappai workflow. For example, you might use the Parse JSON component to extract specific information from the Result.

Usage Example

Let’s say you want to get the current weather from a weather API. You would:

  1. Enter the API URL in the URLs field (e.g., https://api.weather.com/weather).
  2. Choose “GET” as the Method.
  3. (Optional) Add any necessary Query Parameters (e.g., {"location": "London"}).
  4. Run the component.

The output will contain the weather data from the API.

Templates

[This section will be populated with links to templates once they are available.]

  • Parse JSON: Use this component to extract specific data from the JSON response of the API Request.
  • Google Sheet Writer: Write the API response data to a Google Sheet for easy viewing and analysis.
  • Many other components: The output of this component can be used as input for many other components in Nappai, depending on your workflow.

Tips and Best Practices

  • Always check the API documentation of the website you’re requesting data from. This will tell you the correct URL, method, headers, and parameters to use.
  • Start with simple requests and gradually increase complexity.
  • Use the Curl input to simplify the process of setting up complex requests.
  • Test your requests thoroughly to ensure they are working correctly.

Security Considerations

  • Never include sensitive information (like API keys or passwords) directly in your Nappai workflow. Use environment variables or secure configuration methods to store and manage sensitive data.
  • Be aware of the security implications of the APIs you are using. Review their security documentation.
  • Only use trusted and reputable APIs.