Wized Docs

Appearance

Understanding the Body in API Requests ​

The Body of an API request is where you send structured data directly to the server. This is particularly useful for create, update, or modify operations and is most commonly used with the POST, PUT, and PATCH methods.

When to Use the Body ​

  1. Methods for Data Transmission:
    The Body is primarily utilized in POST, PUT, and PATCH requests, which are designed to send data to the server. The data within the Body contains the necessary details for the server to process and respond to your request.

  2. Large or Structured Data:
    If your request involves transmitting substantial amounts of data or complex data structures (like arrays or objects), the Body is the ideal space to include this information. It supports the JSON format, allowing detailed and hierarchical organization of data.

  3. Sensitive Information:
    For confidential data, such as user credentials or payment details, it is advisable to use the Body in conjunction with secure transmission protocols like HTTPS. Storing sensitive information in the Body enhances security by keeping it separate from the URL, thereby reducing its exposure.

TIP

Always consult the API documentation to understand the specific requirements for the data you are sending, including expected formats and structures.

Structure of the Body ​

In Wized, the Body content is structured as key-value pairs, offering greater versatility compared to traditional URL parameters. Here’s a breakdown:

  • Key: This acts as the identifier for the data being sent, such as "username" or "address".
  • Value: The value can be of any data type or format, including text, numbers, arrays, or objects. Additionally, the value can dynamically retrieve data from your application through the Function Editor.

URL Parameters VS Body ​

When determining whether to use URL parameters or the Body in your requests, it is essential to refer to the API documentation for specific guidelines. Here are some general recommendations:

  • Use URL Parameters: Opt for URL parameters when handling simple filters or search queries, particularly in GET requests where data can be appended directly to the URL.
  • Use the Body: Choose the Body when dealing with complex data structures, sensitive information, or when making requests with POST, PUT, or PATCH methods that necessitate structured content.

information

By adhering to these guidelines, you can ensure that your API requests are both effective and compliant with the specifications of the external services you are interacting with.