Skip to main content

REST-Side Configuration (Enterprise)

MAPS can connect to the Inmarsat / Orbcomm REST API endpoints on the enterprise side.
This mode is best suited for centralized fleet or enterprise applications managing thousands of devices.

Example Configuration​

- name: "Inmarsat IoT Nano Interface"
  protocol: satellite
  auth: anon
  url: satellite://inmarsat:0/
  httpRequestTimeoutSec: 30
  incomingMessagePollInterval: 15
  outgoingMessagePollInterval: 60
  sharedSecret: "This is a shared secret to use"
  maxInflightEventsPerDevice: 2
  outboundNamespaceRoot: "/inmarsat/{deviceId}"
  outboundBroadcast: "/inmarsat/broadcast"
  baseUrl: "http://localhost:8085/v1"

  remoteAuthConfig:
    username: "demo-user"
    password: "demo-password"

  mailboxId: "mailbox-001"
  mailboxPassword: "mailbox-secret"
  namespaceRoot: "/{mailboxId}/"

Key Configuration Parameters​

Base URL​

  • baseUrl — REST endpoint root for device messaging APIs.

Polling​

  • incomingMessagePollInterval —
    How often MAPS polls for incoming events from the remote REST API.
    This is the "downlink check" cycle to see if new messages have arrived.

    • Minimum: 10s
    • Default: 15s
    • Typical: Shorter intervals for near–real time, longer intervals for cost-sensitive satellite links.

  • outgoingMessagePollInterval —
    How often MAPS polls for and sends any queued outbound data packets to the REST API.
    This is the "uplink check" cycle to push pending data.

    • Minimum: 15s
    • Default: 60s
    • Typical: Longer intervals are common to reduce bandwidth and API call costs.

Together, these poll intervals provide a heartbeat mechanism between MAPS and the enterprise REST endpoint:

  • Incoming interval ensures timely receipt of new device data.
  • Outgoing interval ensures pending data packets are flushed regularly.

Timeouts and Flow Control​

  • httpRequestTimeoutSec — max time an HTTP request waits before failing.
  • maxInflightEventsPerDevice — caps concurrent messages per device to prevent overload.

Namespaces​

  • outboundNamespaceRoot — target namespace for device uplink messages.
  • outboundBroadcast — namespace for broadcast data.
  • namespaceRoot — root mapping for mailbox-driven routing.

Security​

  • sharedSecret — optional secret for backend authentication.
  • remoteAuthConfig — API credentials for the REST endpoint.

Mailbox (Optional, ViaSat/IDP Specific)​

  • mailboxId / mailboxPassword — mailbox credentials for store-and-forward messaging.

Defaults and Enforced Minimums​

  • incomingMessagePollInterval — must be ≥10s (defaults to 15).
  • outgoingMessagePollInterval — must be ≥15s (defaults to 60).
  • deviceInfoUpdateMinutes — must be ≥10 (defaults to 15).

Typical Use Case​

REST-side integration is best for:

  • Large-scale fleet management (hundreds → thousands of devices).
  • Enterprise data aggregation without requiring GNSS/visibility.
  • Bridging Inmarsat/Orbcomm REST APIs into MQTT / AMQP / NATS / REST within MAPS.

Polling Interval Timeline​