Keitaro icon

Keitaro

Работа с API Keitaro

Overview

This node integrates with the Keitaro API to manage various resources such as bots, campaigns, streams, and more. Specifically, for the 'bot' resource and 'delete' operation, it deletes a bot identified by its ID. This node is useful for automating the management of marketing and tracking entities within Keitaro, such as creating, updating, retrieving, or deleting bots and other resources. For example, it can be used to programmatically remove a bot from Keitaro without manual intervention.

Use Case Examples

  1. Deleting a bot by specifying its bot ID to remove it from the Keitaro system.
  2. Retrieving information about a bot or updating its details using the same node with different operations.

Properties

Name Meaning
ID Бота The unique identifier of the bot to be deleted. This property is required for the delete operation on the bot resource.

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 the API key masked for security.
  • resource - The resource type involved in the operation, e.g., 'bot'.
  • operation - The operation performed, e.g., 'delete'.
  • success - Indicates if the operation was successful (true for delete operation).
  • data - The data returned from the Keitaro API after the delete operation, typically confirmation of deletion.

Dependencies

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

Troubleshooting

  • Ensure the bot ID is provided and correctly formatted; missing or invalid IDs will cause errors.
  • Verify that the API key and domain are correctly set in the credentials; missing credentials will prevent API access.
  • Check that the operation 'delete' is supported for the 'bot' resource; unsupported operations will throw errors.
  • API errors will include status codes and messages; review these to understand issues such as permission problems or resource not found.

Links

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

Discussion