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 subscription data from the "Clube De Assinaturas" resource using the GET /v1/clube/assinaturas operation. It allows users to query subscription records with various filters and sorting options, making it useful for managing and analyzing customer subscriptions in a club or membership context.

Typical use cases include:

  • Fetching paginated lists of active or inactive subscriptions.
  • Filtering subscriptions by customer name or CPF (a Brazilian individual taxpayer registry identification).
  • Sorting subscriptions by recent activity, customer name, status, or next payment date.
  • Integrating subscription data into workflows for reporting, notifications, or further processing.

Properties

Name Meaning
Page The page number of results to retrieve (pagination).
Page Size Number of subscription records per page.
Cliente Cpf Filter subscriptions by the customer's CPF (Brazilian tax ID).
Cliente Nome Filter subscriptions by the customer's name.
Plano Id Filter subscriptions by the subscription plan ID.
Status Filter subscriptions by their status. Options: Ativa, Atrasada, Suspensa Por Falta De Pagamento, Cancelada, Encerrada, Aguardando Pagamento, Cancelada Em Periodo De Consumo.
Ordenar Por Sort the results by one of the following: Assinatura Mais Recente, Cliente Nome, Assinatura Nome, Status, Proximo Pagamento, Cobranca Encerra Apos.

Output

The node outputs an array of JSON objects representing subscription records retrieved from the API. Each item corresponds to one subscription and contains all fields returned by the Trinks API for this endpoint.

If the API returns binary data (not indicated here), it would be included accordingly, but this operation primarily returns JSON data about subscriptions.

Dependencies

  • Requires an API key credential and an establishment ID credential for authenticating requests to the Trinks API.
  • The base URL for the API is https://api.trinks.com.
  • The node sends requests with headers including Accept: application/json, Content-Type: application/json, and authentication headers containing the API key and establishment ID.

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication errors.
    • Providing invalid filter values (e.g., non-numeric page numbers) may result in request failures.
    • Requesting pages beyond available data may return empty results.
  • Error messages:
    • If the operation name is incorrect or not found, the node logs available operations and throws an error indicating the operation was not found.
    • Network or API errors are propagated; enabling "Continue On Fail" allows workflow continuation with error details in output.
  • Resolution tips:
    • Verify API key and establishment ID credentials are correctly configured.
    • Ensure input parameters conform to expected types and allowed values.
    • Use pagination properties to navigate through large datasets.

Links and References

Discussion