Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node interacts with an Evolution API to manage proxy settings for instances. It allows users to either set (activate or deactivate) a proxy configuration or fetch (check) the current proxy settings of a specified instance. This is useful in scenarios where network traffic needs to be routed through a proxy server for security, monitoring, or compliance reasons.

Practical examples:

  • Enabling a corporate proxy on an instance before sending messages.
  • Disabling the proxy when direct connection is preferred.
  • Checking the current proxy status of an instance to verify configuration.

Properties

Name Meaning
Instance Name The name of the instance that will send the message.
What Do You Want to Do Choose between activating/deactivating the proxy or checking the proxy status. Options: "Definir Proxy" (setProxy), "Verificar Proxy" (findProxy).
Ativar Proxy Boolean flag to enable (true) or disable (false) the proxy integration.
Protocolo Do Proxy Protocol used by the proxy. Options: HTTP, HTTPS.
Host Do Proxy Host address of the proxy server.
Porta Do Proxy Port number of the proxy server.
Usuário Do Proxy Username for authenticating with the proxy server.
Senha Do Proxy Password for authenticating with the proxy server.

Output

The node outputs a JSON array containing the result of the proxy operation performed. The exact structure depends on whether the user chose to set or fetch the proxy:

  • For setting the proxy, the output typically confirms success or failure of the operation.
  • For fetching the proxy, the output contains the current proxy configuration details of the instance.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Evolution API.
  • The node uses the base URL https://doc.evolution-api.com/api-reference for API requests.
  • Proper network access to the Evolution API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Incorrect instance name may cause the API to fail to find the target instance.
    • Invalid proxy host, port, username, or password can lead to authentication or connection errors.
    • Choosing an unsupported operation or resource combination will throw an error.
  • Error messages:

    • "Operação não suportada." indicates the selected operation is not supported for the chosen resource.
    • Network or authentication errors from the API should be checked by verifying credentials and proxy details.

Links and References

Discussion