Unified Endpoint

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.

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}

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:

• Soracom Beam
• Soracom Funnel
• Soracom Funk
• Soracom Harvest

---

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:

• Funnel and Harvest are enabled for a group. When an Air for Cellular subscriber in the group sends data to unified.soracom.io, Unified Endpoint will redirect the data to both Funnel and Harvest.
• Beam and Harvest are enabled for a group. When a Sigfox or LoRa device in the group sends data, Unified Endpoint will redirect the data to both Beam and Harvest. (Beam configuration is not required for Sigfox and LoRa devices).
• Funnel and Harvest are enabled for a group. When an Air for Cellular plan01s or plan01s - LDV subscriber in the group sends an SMS to 901001, Unified Endpoint will redirect the message to both Funnel and Harvest.

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

• When using Unified Endpoint with Soracom Beam:
  • The HTTP entry point is only compatible with HTTP POST requests. If your application utilizes other HTTP request types, please use the Beam entry point address instead of the Unified Endpoint address.
  • The Website and MQTT entry points are not available. If your application utilizes either entry point, please use the repsective Beam entry point address instead of the Unified Endpoint address.
  • The TCP → TCP/TCPS entry point is not available. If your application utilizes this entry point, please use the Beam entry point address instead of the Unified Endpoint address.
  • Unified Endpoint will return a response even if the Skip status code option is enabled for the TCP → HTTP/HTTPS or UDP → HTTP/HTTPS entry points. To limit the size of the response, you can configure a custom response format for Unified Endpoint.
• When using Unified Endpoint to send data to Soracom Funnel or Soracom Harvest:
  • The SORACOM Binary Format v1 data format is not supported.
• When sending data to Unified Endpoint using SMS, ensure that your device's SMS header option is disabled. If a header is included, the SMS User Data field will be processed as-is and will result in unwanted or malformed text content.
• Customers cannot specify a timestamp using X-Soracom-Timestamp header when sending data to the Unified Endpoint (unified.soracom.io or uni.soracom.io)