Keitaro icon

Keitaro

Работа с API Keitaro

Overview

This node integrates with the Keitaro API to perform various operations on different resources such as campaigns, streams, landings, offers, users, postbacks, conversions, and more. Specifically, for the 'Постбэк' (Postback) resource, it supports a 'Тестировать' (Test) operation that allows users to test a postback by sending test conversion data to the Keitaro system. This is useful for verifying that postback URLs and conversion tracking are correctly configured. For example, a user can input a click ID, conversion status, payout amount, and other parameters to simulate a conversion event and check the response from Keitaro.

Use Case Examples

  1. Testing a postback URL by sending a test conversion with a specific click ID and status to ensure the postback is working correctly.
  2. Creating or updating postback configurations with detailed parameters such as name, URL, status, trigger, HTTP method, and advanced settings.
  3. Fetching lists or details of various resources like campaigns, clicks, conversions, and statistics from Keitaro for reporting or automation purposes.

Properties

Name Meaning
Тестирование постбэка Contains test data for simulating a postback conversion event, including click ID, status, payout, cost, currency, transaction ID, and sub ID 1.

Output

JSON

  • request
    • url - The URL of the API request made to Keitaro.
    • method - The HTTP method used for the API request.
    • headers - Headers sent with the API request, with sensitive data like API keys masked.
  • resource - The resource type involved in the operation (e.g., postback).
  • operation - The operation performed (e.g., test).
  • success - Indicates if the operation was successful (true/false).
  • data - The data returned from the Keitaro API, such as the response to the test postback.
  • error - Error details if the operation failed, including message, stack trace, HTTP status, and response data.

Dependencies

  • Keitaro API

Troubleshooting

  • Ensure that the API credentials (domain and API key) are correctly set in the node credentials; missing or incorrect credentials will cause authentication errors.
  • For the 'test' operation on the 'postback' resource, the 'click_id' field is required; omitting it will result in an error.
  • When fetching data with 'getAll' operations, ensure that required parameters like date ranges or intervals are provided to avoid errors about missing parameters.
  • If the API returns an error status code (outside 200-299), the node will throw an error with the status code and message; check the API response for details.
  • If the node is set to continue on fail, errors will be returned in the output JSON with detailed information for debugging.

Links

  • Keitaro API Documentation - Official documentation for the Keitaro API, useful for understanding available endpoints and parameters.

Discussion