Evolution API icon

Evolution API

Interact with Evolution API

Overview

This node interacts with the Evolution API to manage proxy settings for instances. Specifically, it allows users to either define (set) a proxy configuration or verify (find) an existing proxy setup for a given 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 include:

  • Setting up a new proxy for an instance to control outbound connections.
  • Checking if a proxy is currently configured and active on an instance before performing network operations.

Properties

Name Meaning
Nombre De La Instancia The name of the instance for which the proxy configuration will be applied or checked.
Qué Desea Hacer Choose between "Definir Proxy" (set/activate proxy) or "Verificar Proxy" (check existing proxy).
Activar Proxy Boolean option to enable or disable the proxy integration (only when setting the proxy).
Protocolo Del Proxy Protocol used by the proxy: HTTP or HTTPS (only when setting the proxy).
Host Del Proxy The hostname or IP address of the proxy server (only when setting the proxy).
Puerto Del Proxy The port number on which the proxy server listens (only when setting the proxy).
Usuario Del Proxy Username credential for authenticating with the proxy server (only when setting the proxy).
Contraseña Del Proxy Password credential for authenticating with the proxy server (only when setting the proxy).

Output

The node outputs a JSON array containing the result of the proxy operation performed:

  • When defining a proxy, the output typically includes confirmation details about the proxy configuration status.
  • When verifying a proxy, the output contains information about the current proxy settings or their absence.

No binary data output is indicated.

Dependencies

  • Requires an API key credential to authenticate with the Evolution API.
  • The node depends on the Evolution API endpoint at https://doc.evolution-api.com/api-reference.
  • Proper network access to the Evolution API service is necessary.

Troubleshooting

  • Common Issues:

    • Incorrect instance name may lead to failure in setting or finding proxy configurations.
    • Invalid proxy credentials (username/password) will cause authentication errors.
    • Network connectivity issues to the Evolution API endpoint can prevent successful execution.
  • Error Messages:

    • "Operação não suportada." indicates that the selected operation is not supported for the chosen resource; ensure correct Resource and Operation selections.
    • Authentication failures usually require checking the provided API key and proxy credentials.
    • Missing required parameters (e.g., proxy host, port) will cause validation errors; ensure all mandatory fields are filled.

Links and References

Discussion