Evolution API Direct icon

Evolution API Direct

Interact with Evolution API using direct URL and API Key

Overview

This node, named "Evolution API Direct," allows users to interact directly with the Evolution API by specifying a resource and operation along with necessary parameters such as server URL, API key, and instance name. The specific operation "Reiniciar Instancia" (Restart Instance) under the "Instancia" (Instance) resource enables users to restart a particular instance by its name.

Common scenarios for this node include automating instance management tasks such as restarting instances remotely without manual intervention. For example, if an instance becomes unresponsive or requires a reset after configuration changes, this node can be used in workflows to trigger a restart automatically.

Properties

Name Meaning
Server URL The full URL of your Evolution API endpoint (e.g., https://api.exemplo.com).
API Key The API key credential required to authenticate requests to the Evolution API.
Nome Da Insticância The name of the instance you want to restart.

Output

The node outputs a JSON array containing the response from the Evolution API after attempting to restart the specified instance. The exact structure depends on the API's response but typically includes status information about the restart operation.

If the API returns any binary data (not indicated here), it would be included accordingly, but based on the provided code and properties, the output is expected to be JSON only.

Dependencies

  • Requires access to the Evolution API endpoint specified by the user.
  • Needs a valid API key credential for authentication.
  • The node expects the user to provide the correct server URL and instance name.

Troubleshooting

  • Operation not supported error: If the node throws an error stating the operation is not supported, verify that the resource and operation names are correctly set to "Instancia" and "Reiniciar Instancia" respectively.
  • Authentication errors: Ensure the API key is valid and has sufficient permissions to perform instance restarts.
  • Invalid server URL: Confirm the server URL is correct and accessible from the environment where n8n runs.
  • Instance not found: If the instance name does not exist or is misspelled, the API may return an error; double-check the instance name input.

Links and References

  • Evolution API Documentation (as referenced in the default base URL)
  • Consult your Evolution API provider for detailed API usage and authentication requirements.

Discussion