Zappfy API icon

Zappfy API

Interact with Zappfy API

Overview

The node "Zappfy API" allows interaction with the Zappfy service through its API. Specifically, for the resource Perfil (Profile) and operation Buscar Perfil (Fetch Profile), it enables retrieving profile information of a contact from a specified instance. This is useful in scenarios where you want to programmatically access user or business profile details within the Zappfy platform, such as integrating contact data into workflows, automating customer support, or enriching CRM records.

Properties

Name Meaning
Nome Da Instância The name of the Zappfy instance to connect to. This identifies which instance to query.
Contato The contact number whose profile is to be fetched.

Output

The node outputs a JSON array containing the profile data retrieved from the Zappfy API for the specified contact. Each item in the output array corresponds to the profile information returned by the API, typically including fields such as contact details, profile status, and any other metadata provided by Zappfy.

If the API supports binary data related to profiles (e.g., profile pictures), this would be included in the binary output field, but based on the static code and properties, the primary output is JSON-formatted profile data.

Dependencies

  • Requires an active connection to the Zappfy API.
  • Needs an API authentication credential configured in n8n (referred generically as an API key or token).
  • The base URL for requests is set to https://docs.zappfy.io/api-reference.
  • The node depends on internal helper functions mapped in resourceOperationsFunctions to handle specific resource-operation logic.

Troubleshooting

  • Unsupported Operation Error: If the node throws an error stating the operation is not supported, verify that the resource and operation names are correctly set and supported by the node.
  • Missing Required Parameters: Ensure that both "Nome Da Instância" and "Contato" are provided; these are required for the fetch-profile operation.
  • API Authentication Issues: Confirm that the API credentials are correctly configured and valid.
  • Network or API Errors: Check network connectivity and the availability of the Zappfy API endpoint.

Links and References

Discussion