Perfex CRM

Interagir com o Perfex CRM via WON API

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 Contato (Contact) resource and the Listar (List/Get All) operation, the node fetches a list of contacts from the Perfex CRM.

Typical use cases include:

  • Retrieving all contacts or filtered subsets of contacts for reporting or synchronization.
  • Automating workflows that require contact data extraction from Perfex CRM.
  • Integrating contact lists into other systems or processes.

For example, you might use this node to get all active contacts in Brazil by applying JSON filters, or limit the number of contacts retrieved per request for pagination purposes.

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 (for paginated results).
- Filtros JSON string representing filters to apply to the search, e.g., {"active": 1, "country": "Brasil"}.

These properties allow fine control over which contacts are returned and how many, supporting pagination and filtering based on contact attributes.

Output

The output is an array of JSON objects, each representing a contact record retrieved from the Perfex CRM. The exact structure depends on the CRM's API response but typically includes fields such as contact ID, first name, last name, email, phone number, title, and status indicators.

No binary data is output by this node.

Example output snippet (conceptual):

[
  {
    "id": 123,
    "firstname": "João",
    "lastname": "Silva",
    "email": "joao.silva@example.com",
    "phonenumber": "+5511999999999",
    "title": "Manager",
    "is_primary": true,
    "active": true
  },
  ...
]

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 Perfex CRM API endpoint.
  • The user must configure the node with valid credentials including the base URL of the Perfex CRM instance and an API token.

Troubleshooting

  • Invalid JSON in Filters: If the filters property contains invalid JSON, the node will throw an error. Ensure the JSON syntax is correct.
  • Authentication Errors: If the API token is missing or invalid, errors like "Erro de autenticação: Token inválido ou não fornecido" will occur. Verify the API token credential.
  • Resource Not Found: A 404 error indicates the requested resource or endpoint does not exist. Check the resource and operation parameters.
  • Connection Issues: Network problems or incorrect base URL configuration can cause connection errors ("Erro de conexão com o servidor").
  • Limit and Page Values: Setting limits outside the allowed range (1-1000) or invalid page numbers may cause unexpected behavior or errors.

To resolve these issues:

  • Validate JSON filter strings before input.
  • Confirm API credentials and permissions.
  • Verify the Perfex CRM API URL.
  • Use appropriate pagination values.

Links and References


This summary focuses on the "Contato" resource with the "Listar" operation, describing how to list contacts from Perfex CRM using this n8n node.

Discussion