Zappfy API icon

Zappfy API

Interact with Zappfy API
Join our community

Actions48

Overview

This node, named "Zappfy API," allows users to interact with the Zappfy API. Specifically, for the resource "Perfil" and operation "Buscar Configurações De Privacidade" (Search Privacy Settings), it enables retrieving privacy configuration details of a given profile instance. This can be useful in scenarios where you want to programmatically access or audit privacy settings associated with user profiles or instances within the Zappfy platform.

Practical examples include:

  • Automatically fetching privacy settings to verify compliance.
  • Integrating privacy configurations into dashboards or reports.
  • Triggering workflows based on specific privacy settings retrieved.

Properties

Name Meaning
Nome Da Instância The name of the instance to query. This is a required string input where you specify which profile instance's privacy settings you want to retrieve.

Output

The node outputs a JSON array containing the results returned by the Zappfy API for the requested privacy settings. Each item in the array corresponds to the privacy configuration data of the specified profile instance.

If the API returns binary data (not indicated in the provided code), it would typically represent files or media related to the profile's privacy settings, but this is not evident here.

Dependencies

  • Requires an active connection to the Zappfy API endpoint at https://docs.zappfy.io/api-reference.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests to the Zappfy API.
  • The node depends on internal helper functions mapped in resourceOperationsFunctions to execute the correct API call based on the selected resource and operation.

Troubleshooting

  • Operation Not Supported Error: If you select an unsupported operation for the resource, the node throws an error stating the operation is not supported. Ensure that "Buscar Configurações De Privacidade" is correctly spelled and available for the "Perfil" resource.
  • Missing or Invalid Instance Name: Since "Nome Da Instância" is required, leaving it empty or invalid may cause the API call to fail or return no data.
  • API Authentication Issues: Failure to provide valid API credentials will result in authorization errors. Verify that the API key or token is correctly set up in n8n.
  • Network or Endpoint Errors: Connectivity issues or incorrect base URL configurations can prevent successful API calls.

Links and References

Discussion