Hybrid Enabler Service - Getting Started

Download OpenAPI specification:Download

Getting Started

At Your Side:

  1. Prepare Your Infrastructure

    Ensure your network, compute, and security infrastructure is configured to host the Hybrid Enabler Service. Set up physical or virtual hosts with sufficient capacity and ensure they meet the prerequisites for running your local iotcomms.io services.
  2. Install the Hybrid Enabler Agent

    Download and install the Hybrid Enabler software on the designated hosts. Follow the installation guide to ensure proper configuration and connectivity to the Hybrid Enabler Service.
  3. Network Configuration

    • Allow communication between the Hybrid Enabler software and the iotcomms.io Hybrid Enabler Service. Ensure that necessary firewall rules are in place to permit outbound HTTPS traffic for API communication.

    • Configure local DNS settings to enable service discovery for site-local APIs and access to deployed services.

  4. Set Up Local Storage

    Prepare your local S3-compatible storage for use with the Hybrid Enabler Service. Assign storage locations for recorded calls, IVR phrase files, and application logs as required for each deployed iotcomms.io service.

Provisioning the Service:

  1. Register Hosts with the Hybrid Enabler Service

    Use the provided web interface or APIs to register your local hosts with the Hybrid Enabler Service. This step ensures that the iotcomms.io team can manage and deploy services on your infrastructure.
  2. Deploy iotcomms.io Services

    Initiate the deployment of your selected iotcomms.io services through the Hybrid Enabler interface. Verify that the services are installed and running locally on your registered hosts.
  3. Configure Callback Destinations

    Define local callback URLs to receive event notifications from the deployed services. Ensure these URLs are accessible within your network and can handle real-time events.
  4. Set Up APIs for Local Integration

    Integrate your applications with site-local APIs provided by the Hybrid Enabler Service. This allows access to functions such as call recording, IVR, and alarm processing within your private environment.

Testing the Service:

  1. Validate Service Deployment

    Access the web interface or use monitoring tools to confirm that all deployed services are operational. Verify connectivity between the Hybrid Enabler Agent and the Hybrid Enabler Service.
  2. Test Local APIs

    Use test scripts or API tools to invoke site-local APIs for the locally deployed services. Ensure that requests are processed and responses are returned as expected.
  3. Check Data Storage

    Verify that recorded calls, phrase files, and application logs are being stored correctly in your local S3 storage. Confirm that the storage paths align with your configuration.
  4. Monitor Service Logs

    Review iotcomms.io services´ logs to ensure proper functionality and to identify any issues during setup. Use the logs to verify events such as API calls, service interactions, and storage operations.

This setup ensures your Hybrid Enabler Service is fully configured, operational, and ready to manage mission-critical communication and data securely within your private infrastructure.