Kiwify icon

Kiwify

Interagir com a API da Kiwify

Overview

This node integrates with the Kiwify API to perform various operations related to account management, products, sales, affiliates, webhooks, payouts, and balances. Specifically, the "Consultar Saldo Específico" (Get Specific Balance) operation retrieves the balance for a particular legal entity ID within the Kiwify platform.

Common scenarios where this node is beneficial include:

  • Fetching financial balances for specific legal entities managed in Kiwify.
  • Automating financial reporting or reconciliation processes by retrieving up-to-date balance information.
  • Integrating Kiwify account data into broader workflows that require knowledge of available funds per legal entity.

Practical example:

  • A user wants to check the current balance of a specific legal entity before initiating a payout or financial transaction. Using this node with the "Consultar Saldo Específico" operation and providing the legal entity ID will return the relevant balance details.

Properties

Name Meaning
Legal Entity ID ID of the legal entity for which to retrieve the specific balance. This is a required string input.

Output

The node outputs JSON data representing the response from the Kiwify API for the requested operation. For the "Consultar Saldo Específico" operation, the output JSON contains the balance details associated with the specified legal entity ID.

The exact structure depends on the Kiwify API response but typically includes fields such as available balance, pending amounts, currency, and other financial metadata related to that legal entity's balance.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Kiwify API.
  • The node performs OAuth token retrieval internally using client credentials provided via the configured API key credential.
  • Network access to https://public-api.kiwify.com is necessary.
  • No additional environment variables are required beyond the API credential configuration.

Troubleshooting

  • Authentication errors: If the node fails to authenticate, verify that the API key credential is correctly configured with valid client ID and secret.
  • Invalid Legal Entity ID: Providing an incorrect or non-existent legal entity ID may result in API errors or empty responses. Confirm the ID is accurate.
  • API rate limits or downtime: Temporary failures might occur if the Kiwify API is unavailable or rate-limited. Retry after some time or check Kiwify status.
  • Error messages: The node throws errors with messages returned from the Kiwify API. Review these messages to identify issues such as missing parameters or permission problems.
  • Continue on Fail: If enabled, the node will continue processing subsequent items even if one item causes an error, returning the error message in the output JSON.

Links and References

Discussion