Wized Docs

Appearance

Creating an API ​

To create an API request in Wized, you first need to set up an App instance in the Wized Configurator. Once the App is created, you will be able to generate multiple API requests that will interact with that specific service or application.

Locating and Creating Requests ​

Requests Panel ​

Within the Configurator, select the Requests panel. Here you can see all created requests and organize the connections to each API.

Creating a New Request ​

To create a new request, press the "Add Request" button. This will open a configuration window where you can define the details of your request.

Request Configuration Parameters ​

Once in the Requests panel, configure the following key parameters:

  • Endpoint: Specify the path you want to access within the base URL (for example, /weather). The combination of the endpoint and the base URL of the App will form the complete request URL.

  • Method: Select the type of action you want to perform. This can be GET, POST, PUT, PATCH, or DELETE, depending on your needs.

  • Headers: Add additional information about your request, such as Content-Type or authentication credentials (for example, Authorization). Headers are specified in key-value format. Here’s an example:

  • Parameters: These additional data are added to the request URL to filter or customize the response, as in the following example:

  • Body: Include the data you want to send to the service, typically in JSON (JavaScript Object Notation) format. This is essential for POST or PUT requests.