Soracom Beam

Website Entry Point

This entry point behaves similarly to the HTTP entry point, accepting HTTP requests from an Air for Cellular device and forwarding the request to the forwarding destination via HTTP or HTTPS. Unlike the HTTP entry point, this entry point will automatically map any URI path from the original HTTP request to the forwarding destination. For example, an HTTP request sent to http://beam.soracom.io:18080/my/custom/path will be forwarded to https://myserver.example.com/my/custom/path without the need of defining the URI path within Beam.

---

Configuration

Entry Point

Your device should be configured to send data to: http://beam.soracom.io:18080 or http://beam.soracom.io.

Parameters

• Configuration name (string, required) - A string to identify this configuration.
• Destination - The forwarding destination.
  • Protocol (HTTP or HTTPS, required) - The protocol to use for forwarding HTTP requests.
  • Host name (string, required) - The FQDN of the forwarding destination.
  • Port number (number, required) - The port number of the forwarding destination.
• Header manipulations - Operations to perform on the HTTP request headers.
  • IMSI header - Adds X-Soracom-IMSI: {IMSI} to the HTTP request header.
  • IMEI header - Adds X-Soracom-IMEI: {IMEI} to the HTTP request header.
  • Signature header - Adds X-Soracom-Signature: {Signature} to the HTTP request header. This option requires IMSI header or IMEI header to be enabled in order to generate the signature.
  • Pre-Shared Key - The key to use when generating the Signature header.
  • Custom headers - Additional options for adding, modifying, or removing headers from HTTP requests before they are forwarded to the destination.
  • Authorization header - Adds Authorization: {Parameter} to the HTTP request header.

Refer to the Header Manipulations documentation for additional details.

---

Behavior

The Website entry point has the same behavior as the HTTP entry point.

---

Advanced Configuration

The Website entry point can also be configured through the Soracom API or CLI by using the SoracomBeam namespace.

Configuration should be performed using http://beam.soracom.io:18080 as the configuration key value.

Parameters

• key (string, required) - http://beam.soracom.io:18080
• value (object, required) - The configuration parameters.
  • name (string, optional) - Name to identify this configuration.
  • destination (string, required) - URL of the forwarding destination.
  • enabled (boolean, required) - Enables or disables the configuration.
  • addSubscriberHeader - (boolean, required) - Enables or disables adding subscriber information as a HTTP header or MQTT topic in the forwarded request.
  • customHeaders (object, optional) - Defines custom headers behavior. Each custom header is defined using:
    • X-Header-Name (string, required) - Name of the custom header.
      • action (string, required) - Defines the header behavior using one of the following values:
        • append - Appends the defined header to the HTTP request.
        • replace - Replaces any existing header with the defined header value.
        • delete - Deletes the header from the HTTP request.
      • headerKey (string, required) - The header name.
      • headerValue (string, required) - The header value.
  • addSignature (boolean, required) - Enables or disables adding a signature header for subscriber verification
  • psk (string, optional) - The Pre-Shared Key (passphrase) to be used when adding a signature header.

Sample

[
  {
    "key": "http://beam.soracom.io:18080",
    "value": {
      "name": "test",
      "destination": "https://beamtest.soracom.io",
      "enabled": true,
      "addSubscriberHeader": true,
      "customHeaders": {
        "X-GROUP-NAME": {
          "action": "replace",
          "headerKey": "X-GROUP-NAME",
          "headerValue": "TEST"
        }
      },
      "addSignature": true,
      "psk": "topsecret"
    }
  }
]