Overview

Soracom Unified Endpoint is a consolidated ingress endpoint service that provides data redirection to Soracom Beam, Funnel, Funk, and Harvest through a single endpoint.

Unified Endpoint overview

When integrating Beam, Funnel, Funk, or Harvest into your IoT application, your device must be configured to send data to one or more of the corresponding entry points, such as beam.soracom.io, funnel.soracom.io, funk.soracom.io, harvest.soracom.io, or other entry point depending on protocol. While you can easily modify each service's configuration in the cloud, changing services requires reconfiguring your device to send data to a different service's entry points.

Unified Endpoint provides a single entry point, which can then be configured on the Soracom platform to redirect data to the desired service. This allows you to define a single device configuration that uses Unified Endpoint's entry points, and then freely choose which Soracom service should receive the data, in order to quickly switch the data handling service as application requirements change or for debugging.

In addition, Unified Endpoint allows you to redirect your data to multiple services, lowering data usage by removing the need to send data multiple times from your device.


Entry Points

Unified Endpoint supports the following device entry point configurations:

Air for Cellular

Entry Point Address
TCP tcp://unified.soracom.io:23080
UDP udp://unified.soracom.io:23080
HTTP http://unified.soracom.io (or port 8888)
SMS*1 901001
USSD*1 *901001*{data}#

*1 - Available only for plan01s and plan01s - LDV SIMs

In all cases, you can also substituted unified.soracom.io with uni.soracom.io in order to shorten the entry point configuration on your device.

Refer to the Limitations section for more information on Unified Endpoint limitations.

Air for Sigfox and Air for LoRaWAN

Data is captured automatically from the device. Configuring the device to send data to a specific entry point is not required.

Soracom Inventory

Data is captured automatically from the device. Configuring the device to send data to a specific entry point is not required.


Destination Services

Unified Endpoint supports redirecting data to the following Soracom services:

Refer to the Limitations section for more information on Unified Endpoint limitations.


Redirection Behavior

Unified Endpoint will automatically redirect data received on its entry points to all Beam, Funnel, Funk, and Harvest configurations that are enabled for that group.

Examples:

Response Format

As Soracom Beam, Funnel, Funk, and Harvest will return response messages to the device in various formats depending on entry point and forwarding destination protocol or service, Unified Endpoint allows you to control how each of those responses should be handled when sending a response to the device.

Response Format Description
Auto (default) If data is redirected to only one service, the response from that service will be returned to the device as-is. If data is redirected to multiple services, a response will be returned in Unified Response format.
Unified Always returns the response in Unified Response format.
SORACOM Beam Only returns Beam responses using Beam's entry point response format. Responses from Funnel, Funk, and Harvest are ignored.
SORACOM Funnel Only returns Funnel response using Funnel's entry point response format. Responses from Beam, Funk, and Harvest are ignored.
SORACOM Funk Only returns Funk response using Funk's entry point response format. Responses from Beam, Funnel, and Harvest are ignored.
SORACOM Harvest Only returns Harvest response using Harvest's entry point response format. Responses from Beam, Funk, and Funnel are ignored.
Custom Returns a custom user-defined response message on redirection success or failure.

For more information on the Unified Response format and Custom response format, refer to the Response Format documentation.


Limitations