Keitaro icon

Keitaro

Работа с API Keitaro

Overview

This node integrates with the Keitaro API to manage user data. Specifically, for the 'Пользователь' (User) resource and the 'Создать' (Create) operation, it allows creating a new user by sending user data in JSON format to the Keitaro API. This is useful for automating user management tasks such as adding new users to the Keitaro system programmatically.

Use Case Examples

  1. Creating a new user in Keitaro by providing user details in JSON format.
  2. Automating user creation workflows in marketing or traffic management systems using Keitaro API integration.

Properties

Name Meaning
Данные Пользователя User data in JSON format to be sent to the Keitaro API for creating or updating a user.

Output

JSON

  • request
    • url - The URL of the API request made to Keitaro.
    • method - 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., 'user'.
  • operation - The operation performed, e.g., 'create'.
  • success - Indicates if the operation was successful (true for create operation).
  • data - The data returned from the Keitaro API after creating the user.

Dependencies

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

Troubleshooting

  • Ensure the API key and domain are correctly set in the node credentials; missing or incorrect credentials will cause authentication errors.
  • The user data JSON must not be empty; otherwise, the node throws an error indicating required data is missing for the create operation.
  • For the 'user' resource, the node expects the 'userData' parameter in JSON format; incorrect JSON formatting will cause request failures.
  • If the API response status code is not in the 2xx range, the node throws an API error with the status code and message.
  • When using the 'create' operation, ensure the user data includes all required fields as per Keitaro API documentation to avoid validation errors.

Discussion