Signal Injection

Accepts XML, JSON, query-string, key/value or plain-text payloads and injects the parsed result into the SBN Immediate Queue so it is processed as an alarm. The parse route returns the same parsed structure without injecting, for testing. Use SBN program 1685 for XML, JSON and query-string translations, and program 1876 for plain text.

Setup

• No signal-injection settings are required.
• The default receiver source ID is 88883; override it per request with the {sousid} route segment.
• SMART SBN: when UseSmartSBN is on in the APIEngine settings and the local insert succeeds, APIEngine repeats the insert on every non-Primary datasource. Other Primary servers are skipped so Active/Active sites do not get duplicate signals.
• A file attached to a multipart request is saved to the APIEngine file store, and its saved file name is added to the parsed JSON as apiengine_filename. If the file cannot be saved, the error is logged and the signal is still injected.

Auth

The signal-injection routes take no APIEngine user token, and they are not listed in the API catalog. Restrict access to them at the network level (firewall, IIS IP and domain restrictions, or a reverse-proxy ACL).

Endpoints

Every inject and parse route accepts GET, POST and PUT. The payload is read from the multipart body field, then the raw request body, then the query string.

Parse (preview only, does not inject)

Inject (writes to the Immediate Queue)

Route parameters:

• receiver: alarm-translation receiver ID. If omitted, APIEngine uses the caller's IP address (see Operational notes).
• sousid: receiver source ID written to the Immediate Queue row; default 88883.
• form, id: alarm-translation form and ID.

The response is the parsed structure, including Rows (one entry per queued row), Rows_Stamps, TranslationPrefix and Error.

Translations

Translation records are maintained in SBN. APIEngine writes a translation prefix followed by the receiver ID into each queued row:

The receiver must match an SBN translation set up for the same prefix.

Operational notes

• IP-based receiver matching: when receiver is empty, APIEngine uses the left-most X-Forwarded-For address, otherwise the connection's remote address. ::1 becomes 127.0.0.1, and IPv4 octets are zero-padded to three digits (for example 192.168.1.10 becomes 192.168.001.010) to match the padded form used in SBN translations. If a reverse proxy fronts APIEngine, make sure it sets X-Forwarded-For, or every receiver resolves to the proxy's address.
• Per-row stamps: Rows_Stamps has one entry per datasource and row. A stamp above -1 means the row was accepted; -1 means the insert failed. With SMART SBN there is one stamp from the local server plus one from each non-Primary datasource.
• Long input: payload rows longer than 128 characters are injected in full.

Direct-Inject Receiver Width

Direct-inject alarms accept the full 12-character receiver.

SQL Injection Hardening

Immediate Queue inserts pass the payload as procedure parameters.