Keitaro icon

Keitaro

Работа с API Keitaro

Overview

This node integrates with the Keitaro API to perform various operations on different resources, including filters. Specifically, for the 'Фильтр' (Filter) resource and the 'Обновить' (Update) operation, the node updates an existing filter by sending updated filter data in JSON format to the Keitaro API. This is useful for users who want to programmatically modify filter configurations in their Keitaro campaigns or traffic management setups.

Use Case Examples

  1. Updating a filter's criteria to refine traffic routing based on new conditions.
  2. Modifying an existing filter to include additional parameters or change existing ones.

Properties

Name Meaning
ID Фильтра The unique identifier of the filter to update.
Данные Фильтра The filter data in JSON format containing the updated filter configuration.

Output

JSON

  • request
    • url - The URL of the API request made to update the filter.
    • method - The HTTP method used for the request (PUT for update).
    • headers
      * Api-Key - The API key used for authentication, masked in output.
  • resource - The resource type, here it will be 'filter'.
  • operation - The operation performed, here it will be 'update'.
  • success - Indicates if the update operation was successful.
  • data - The response data from the Keitaro API after updating the filter.

Dependencies

  • Requires an API key credential for Keitaro API authentication and the domain URL of the Keitaro instance.

Troubleshooting

  • Ensure that the filter ID is provided and valid; missing or incorrect IDs will cause errors.
  • The filter data must be a valid JSON object; invalid JSON will cause the request to fail.
  • API key and domain must be correctly set in credentials; missing or incorrect credentials will prevent API access.
  • The node throws errors if the API response status is not successful (status code outside 200-299).
  • For the 'update' operation, ensure the filter data is not empty, as the API requires data to update the filter.

Links

Discussion