AlfaConnect icon

AlfaConnect

Interact with AlfaConnect services (NimbaSMS, AlfaMail)
Join our community

Actions7

Overview

The AlfaConnect node allows users to interact with the AlfaConnect API platform and its services, including NimbaSMS, AlfaMail, Djomy, and AlfaConnect itself. The 'Generic Get' operation under the AlfaConnect resource enables users to make GET requests to any specified API endpoint path, facilitating flexible data retrieval from the AlfaConnect API. This is useful for scenarios where predefined operations do not cover specific API endpoints or when custom queries are needed. For example, a user can retrieve user data, status information, or other resources by specifying the appropriate API path.

Use Case Examples

  1. Retrieve a list of users by specifying the path '/v1/users' with optional limit and offset parameters.
  2. Fetch status information from the endpoint '/v1/status' to monitor service health.

Properties

Name Meaning
Request Path The API endpoint path to request (e.g., /v1/users, /v1/status). This is a required string input that defines the specific resource or data to retrieve from the AlfaConnect API.
Additional Fields Optional parameters to refine the GET request, including 'Limit' to specify the maximum number of results to return (1-1000) and 'Offset' to skip a number of results, useful for pagination.
Request Options Node-level settings to control request behavior, including batching (splitting input into batches with configurable size and interval), ignoring SSL certificate issues, setting an HTTP proxy, and defining a timeout period for the request.

Output

JSON

  • data - The JSON response data returned from the AlfaConnect API based on the requested endpoint.

Dependencies

  • Requires an API key credential for AlfaConnect API authentication.

Troubleshooting

  • Common issues include incorrect API endpoint paths leading to 404 errors. Verify the 'Request Path' is correct and matches the AlfaConnect API documentation.
  • Timeout errors may occur if the server is slow to respond; adjust the 'Timeout' setting accordingly.
  • SSL certificate validation errors can be bypassed by enabling 'Ignore SSL Issues', but this should be used cautiously due to security risks.
  • Proxy configuration errors can prevent requests from succeeding; ensure proxy settings are correct if used.

Links

Discussion