HTTP Entry Point

This entry point accepts HTTP requests from an Air for Cellular device and forwards the request to the forwarding destination via HTTP or HTTPS. You can create multiple HTTP entry point configurations, provided the path parameter is unique for each configuration.


Configuration

Entry Point

Your device should be configured to send data to: http://beam.soracom.io:8888/{my-custom-path}.

Parameters

Refer to the Header Manipulations documentation for additional details.


Behavior

Request Behavior

When Beam receives an HTTP request, it will close the original request and forward the request to the forwarding destination.

Response Behavior

When Beam receives an HTTP response from the forwarding destination, it will transfer the response directly to the device.


Example

$ curl -v -X POST -H 'Content-Type: application/json' -d '{"key":"value"}' http://beam.soracom.io:8888/
>*   Trying 100.127.127.100...
>* Connected to beam.soracom.io (100.127.127.100) port 8888 (#0)
>> POST / HTTP/1.1
>> Host: beam.soracom.io:8888
>> User-Agent: curl/7.49.0
>> Accept: */*
>> Content-Type:application/json
>> Content-Length: 15
>>
>* upload completely sent off: 15 out of 15 bytes
>< HTTP/1.1 200 OK
>< Content-Type: application/json
>< Date: Wed, 21 Dec 2016 02:25:01 GMT
>< Connection: close
>< Transfer-Encoding: chunked
><
>* Closing connection 0

Advanced Configuration

The HTTP 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:8888/ as the configuration key value.

Parameters

Sample

[
  {
    "key": "http://beam.soracom.io:8888/",
    "value": {
      "name": "My Beam config",
      "destination": "https://myserver.example.com/",
      "enabled": true,
      "addSubscriberHeader": true,
      "addSimIdHeader": true,
      "addMsisdnHeader": true,
      "customHeaders": {
        "X-Group-Name": {
          "action": "replace",
          "headerKey": "X-Group-Name",
          "headerValue": "My header value"
        }
      },
      "addSignature": true,
      "psk": {
        "$credentialsId": "CredentialsID"
      },
      "addAuthorizationHeader": {
        "enabled": false
      }
    }
  }
]