Billing Booth One icon

Billing Booth One

Interact with Billing Booth One API
Join our community

Actions476

Overview

This node interacts with the Billing Booth One API to create an Auto Collection Endpoint. It allows users to configure and register remote server endpoints for automated data collection, specifying connection details, authentication, protocol, and scheduling frequency. This is useful for automating data retrieval from FTP/SFTP/FTPS servers associated with suppliers, supporting scenarios like periodic data imports or integrations with external systems.

Use Case Examples

  1. Create an Auto Collection Endpoint to connect to a supplier's FTP server, authenticating with a username and password, and schedule hourly data collection.
  2. Set up an SFTP endpoint using private key authentication to securely fetch files daily from a remote server for processing.

Properties

Name Meaning
Name The name of the Auto Collection Endpoint to be created.
Address The remote server address or IP where the endpoint connects to collect data.
Authentication Mode The authentication method used to connect to the remote server, either password or private key.
Username The username for authentication on the remote server.
Password The password for authentication on the remote server.
Protocol The protocol used to connect to the remote server, such as FTP, SFTP, or FTPS.
Frequency How often the endpoint should be triggered to collect data, e.g., hourly, every four hours, or daily.
Supplier Id Unique identifier of the supplier associated with this endpoint.
Additional Body Fields Optional additional configuration fields for the endpoint, such as port, enabled status, private key content, scheduling hour, supplier name, and various flags and paths related to CDR and service files.

Output

JSON

  • json - The JSON response from the Billing Booth One API representing the created Auto Collection Endpoint or error details if the operation fails.

Dependencies

  • Billing Booth One API with authentication token

Troubleshooting

  • Ensure the Billing Booth One API credentials are correctly configured and valid to avoid authentication errors.
  • Verify that all required fields (e.g., name, address, username, password) are provided and correctly formatted to prevent request validation errors.
  • If using private key authentication, ensure the private key content is correctly provided and matches the remote server requirements.
  • Check network connectivity and remote server accessibility to avoid connection timeouts or refusals.
  • Review error messages returned in the output JSON for specific issues such as invalid parameters or server errors, and adjust the input accordingly.

Links

Discussion