Kiwify icon

Kiwify

Interagir com a API da Kiwify

Overview

The "Listar Afiliados" operation of the Kiwify node interacts with the Kiwify API to retrieve a paginated list of affiliates. This operation is useful for users who want to manage or analyze their affiliate network by fetching affiliate data filtered by status, product association, or search terms.

Common scenarios include:

  • Displaying affiliates in a dashboard with pagination.
  • Filtering affiliates by their current status (active, blocked, refused).
  • Searching affiliates by name or other searchable fields.
  • Filtering affiliates associated with a specific product.

Example use case: An e-commerce platform owner wants to review all active affiliates promoting a particular product and export their details for commission processing.

Properties

Name Meaning
Tamanho Da Página Number of affiliates to return per page (pagination size).
Número Da Página Page number to retrieve (pagination index).
Status Filter affiliates by status. Options: Todos (all), Ativo (active), Bloqueado (blocked), Recusado (refused).
ID Do Produto Optional filter to get affiliates associated with a specific product ID.
Buscar Optional search term to filter affiliates by matching text.

Output

The output is a JSON array containing affiliate objects as returned by the Kiwify API endpoint /v1/affiliates. Each item represents an affiliate with its details such as ID, status, commission, and related metadata.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Kiwify API.
  • The node uses OAuth token retrieval internally by exchanging client credentials.
  • Requires configuration of the Kiwify account ID in the credentials.
  • Makes HTTP requests to the Kiwify public API endpoints.

Troubleshooting

  • Authentication errors: If the node fails to authenticate, verify that the API credentials (client ID, client secret, and account ID) are correctly configured.
  • Invalid parameters: Ensure that pagination numbers and filters are valid and within expected ranges.
  • Empty results: If no affiliates are returned, check if the filters (status, product ID, search term) are too restrictive or incorrect.
  • API rate limits: Frequent calls may hit API rate limits; consider adding delays or reducing request frequency.
  • Network issues: Connectivity problems can cause request failures; ensure stable internet access.

Common error messages:

  • "Unauthorized": Indicates invalid or expired credentials.
  • "Not Found": Possibly due to invalid product ID or affiliate ID filters.
  • "Bad Request": Usually caused by malformed query parameters.

Resolving these typically involves verifying input parameters and credentials.

Links and References

Discussion