Evolution API Direct icon

Evolution API Direct

Interact with Evolution API using direct URL and API Key
Join our community

Actions64

Overview

The node "Evolution API Direct" allows users to interact directly with the Evolution API by specifying a server URL and an API key. It is designed to perform various operations on different resources exposed by the Evolution API. Specifically, for the resource Instancia and operation Conectar Instancia, this node enables connecting to a particular instance by its name.

This node is beneficial in scenarios where you need to automate or integrate workflows that require direct communication with the Evolution API, such as retrieving data from a specific instance, managing instances programmatically, or triggering actions within an instance.

Example use case:
You want to connect to a named instance of your Evolution API environment to fetch or update data related to that instance. By providing the server URL, API key, and instance name, the node establishes the connection and returns relevant information about the instance.

Properties

Name Meaning
Server URL The full URL of your Evolution API server (e.g., https://api.exemplo.com).
API Key The API key credential used to authenticate requests against the Evolution API.
Nome Da Instância The name of the instance you want to connect to or query within the Evolution API.

Output

The node outputs a JSON array containing the result of the "Conectar Instancia" operation. The exact structure depends on the Evolution API response but typically includes details about the connected instance such as its status, configuration, or metadata.

If the API returns binary data (not indicated here), it would be included in the output's binary property; however, based on the provided code and properties, the output is expected to be purely JSON.

Dependencies

  • Requires access to the Evolution API endpoint specified by the user via the Server URL.
  • Requires a valid API key credential for authentication.
  • No additional external dependencies are indicated in the source code.
  • The node expects the user to configure these credentials and URLs correctly in n8n before execution.

Troubleshooting

  • Operation not supported error: If you select an unsupported operation or resource combination, the node throws an error stating the operation is not supported. Ensure you use the correct resource ("Instancia") and operation ("Conectar Instancia").
  • Authentication errors: If the API key is invalid or missing, the API will reject the request. Verify that the API key is correct and has sufficient permissions.
  • Invalid Server URL: Providing an incorrect or unreachable server URL will cause connection failures. Confirm the URL is accessible and correctly formatted.
  • Missing required parameters: All three properties (Server URL, API Key, Nome Da Instância) are required. Omitting any will likely cause the node to fail or return errors.

Links and References

Discussion