Trinks icon

Trinks

Nó N8N para interagir com a API do Trinks
Join our community

Actions46

Overview

This node integrates with the Trinks API to retrieve customer data ("Clientes"). Specifically, the GET /v1/clientes operation fetches a list of customers based on various filtering criteria such as name, CPF (Brazilian individual taxpayer registry identification), email, phone number, and registration or update date ranges. It supports pagination and optionally includes detailed customer information.

This node is useful in scenarios where you need to synchronize customer data from Trinks into your workflows, perform customer segmentation, or trigger actions based on customer attributes. For example, you could use it to:

  • Retrieve all customers registered within a specific date range.
  • Filter customers by email or phone number for targeted marketing campaigns.
  • Paginate through large customer lists to process them in batches.

Properties

Name Meaning
Page Page number for paginated results (starting at 0).
Page Size Number of records per page returned by the API.
Nome Customer's name to filter the results.
Cpf Customer's CPF (Brazilian tax ID) to filter the results (format: 99999999999).
Email Customer's email address to filter the results.
Telefone Customer's phone number to filter the results (supports local and international formats).
Data Cadastro Inicio Start date/time for customer registration date filter (ISO 8601 format or date only).
Data Cadastro Fim End date/time for customer registration date filter (ISO 8601 format or date only).
Data Alteracao Cadastral Inicio Start date/time for customer data last modification filter (ISO 8601 format or date only).
Data Alteracao Cadastral Fim End date/time for customer data last modification filter (ISO 8601 format or date only).
Incluir Detalhes Boolean flag to include detailed customer information in the response.

Output

The node outputs JSON data representing the response from the Trinks API for the requested customers. The structure typically includes an array of customer objects matching the query parameters, potentially including detailed fields if requested.

Example output JSON structure (simplified):

{
  "clientes": [
    {
      "id": "string",
      "nome": "string",
      "cpf": "string",
      "email": "string",
      "telefone": "string",
      "dataCadastro": "string",
      "detalhes": { /* detailed info if incluirDetalhes=true */ }
    }
  ],
  "page": 0,
  "pageSize": 10,
  "totalRecords": 100
}

No binary data output is indicated by the source code.

Dependencies

  • Requires an API key credential and an establishment identifier credential to authenticate requests to the Trinks API.
  • The base URL for the API is https://api.trinks.com.
  • The node uses standard HTTP headers including Accept: application/json and Content-Type: application/json.
  • Proper configuration of these credentials in n8n is necessary for successful API calls.

Troubleshooting

  • Common issues:

    • Invalid or missing API key or establishment ID will cause authentication failures.
    • Incorrect date formats may lead to API errors; ensure ISO 8601 or YYYY-MM-DD format.
    • Pagination parameters (page, pageSize) must be non-negative integers.
    • Filtering by CPF requires the correct numeric format without punctuation.

  • Error messages:

    • "Operation ... not found": This indicates an invalid operation parameter; verify that the operation string matches exactly GET /v1/clientes.
    • HTTP errors from the API (e.g., 401 Unauthorized, 400 Bad Request) usually indicate credential or parameter issues.

  • Resolution tips:

    • Double-check API credentials and their assignment in the node.
    • Validate input parameters before execution.
    • Use the "Continue On Fail" option in the node settings to handle partial failures gracefully.

Links and References

Discussion