Keitaro icon

Keitaro

Работа с API Keitaro

Overview

This node integrates with the Keitaro API to perform various operations on different resources, including creating, updating, retrieving, and deleting records. Specifically, for the resource "Блэклист" (Blacklist) with the operation "Создать" (Create), the node allows users to create a new blacklist entry by sending JSON-formatted data to the Keitaro API. This is useful for managing blacklist entries programmatically, such as adding IP addresses or other identifiers to a blacklist to block unwanted traffic or users.

Use Case Examples

  1. Creating a new blacklist entry by providing the blacklist data in JSON format, such as blocking a specific IP address or user agent.
  2. Updating existing blacklist entries to modify the criteria or details.
  3. Retrieving blacklist entries to review or audit blocked entities.

Properties

Name Meaning
Данные Блэклиста JSON-formatted data representing the blacklist entry to be created or updated.

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., blacklist).
  • operation - The operation performed (e.g., create).
  • success - Indicates if the operation was successful (true for create).
  • data - The data returned from the Keitaro API after the operation, typically the created blacklist entry details.
  • error - Indicates if there was an error during the operation, present only if an error occurred.

Dependencies

  • Requires an API key credential and domain configuration for Keitaro API access.

Troubleshooting

  • Ensure the API key and domain are correctly set in the node credentials; missing or incorrect credentials will cause authentication errors.
  • The blacklist data must be valid JSON and not empty; otherwise, the node will throw an error indicating missing data for the create operation.
  • For operations requiring an ID (get, update, delete), ensure the ID is provided; missing IDs will cause errors.
  • If the API returns an error status, the node will throw an error with the API's message; check the API response for details.

Links

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

Discussion