Perfex CRM

Interagir com o Perfex CRM via WON API
Join our community

Actions30

Overview

This node integrates with the Perfex CRM system via the WON API, allowing users to interact programmatically with various CRM resources. Specifically for the Lead resource and the Listar (getAll) operation, it retrieves a list of leads from the CRM.

Typical use cases include:

  • Fetching all leads or filtered subsets of leads for reporting or further automation.
  • Paginating through large lead datasets by specifying page numbers and limits.
  • Applying JSON-based filters to narrow down the search results based on lead attributes such as status, source, country, etc.

For example, you could use this node to retrieve all active leads from Brazil, limiting the result to 100 entries per page, and then process or export that data elsewhere.

Properties

Name Meaning
Opções Adicionais Collection of additional options to customize the listing:
- Limite Maximum number of records to return (number between 1 and 1000).
- Página Page number to return (starting at 1).
- Filtros JSON string representing filters to apply to the search, e.g., {"active": 1, "country": "Brasil"}.

Note: The property is named "options" in the node parameters and contains these sub-properties.

Output

The output is an array of JSON objects representing the leads retrieved from the Perfex CRM. Each item corresponds to one lead record with its full set of fields as returned by the API.

The structure of each lead object depends on the CRM's API response but typically includes fields like:

  • id
  • name
  • source
  • status
  • assigned (user responsible)
  • email
  • phonenumber
  • company
  • address
  • city
  • state
  • country
  • zip
  • description

No binary data is output by this operation.

Dependencies

  • Requires an API token credential for authenticating with the Perfex CRM WON API.
  • The node uses Axios HTTP client internally to make requests to the configured base URL.
  • The user must configure the node credentials with the correct API URL and token.
  • The API endpoint used for leads is /won_api/won/api/leads.

Troubleshooting

Common Issues

  • Invalid JSON in Filters: If the filters property contains invalid JSON, the node will throw an error when parsing.
  • Authentication Errors: If the API token is missing or invalid, the node returns an authentication error.
  • Resource Not Found: If the API endpoint is unreachable or the resource does not exist, a 404 error is thrown.
  • Rate Limits or Server Errors: Network issues or server-side errors may cause connection failures or unexpected errors.

Error Messages and Resolutions

  • "Erro de autenticação: Token inválido ou não fornecido"
    Ensure the API token credential is correctly set and valid.

  • "Recurso não encontrado"
    Verify the API URL and resource existence.

  • "Dados inválidos: ..."
    Check the JSON filters or other input data for correctness.

  • "Erro de conexão com o servidor"
    Confirm network connectivity and API server availability.

  • "Erro: <message>"
    General error; review the message for clues and verify inputs.

Links and References

This summary covers the static analysis of the node’s execute logic for the Lead resource with the Listar (getAll) operation, focusing on input properties, output, dependencies, and common troubleshooting points.

Discussion