APIMapper Service

Overview

The APIMapper Service connects SBN to the APIEngine REST service and keeps the two in sync. On a fixed timer it contacts the APIEngine, makes sure it can authenticate, and then carries out whichever of its functions have been enabled — keeping API stored-procedure mappings up to date, and handing off incoming IVR (phone) and interactive text-message activity to be processed.

The service runs continuously, repeating its work each cycle so that mappings stay current and new IVR and SMS activity is picked up as it arrives. It requires a working connection to the APIEngine; if it cannot reach or authenticate against the APIEngine, it sends a notification e-mail and keeps retrying until the connection is restored, then confirms by e-mail once it is back online.

Version Note — Framework (v95 and earlier) vs Current (.NET 8)

On SBN v95 and earlier (.NET Framework), the API Mapper runs as the standalone Windows service described on this page.

On the current (.NET 8) line, this work is built into the APIEngine itself — the APIEngine keeps the API stored-procedure mappings current and processes incoming IVR and interactive SMS internally. On a current/.NET 8 system you therefore do not deploy or run the standalone API Mapper service; the equivalent behavior is configured in the APIEngine. The settings below apply to the Framework (v95 and earlier) line.

Service Manager

Instructions for installing and interacting with this service is found here.

Service Properties

Only properties specific to this service are listed here. Common service properties (SBN Server connection, Logging, SMTP) are found here.

Timer (In Seconds)

How often the service runs a pass. The service waits this many seconds between cycles, then checks the APIEngine connection and carries out whichever functions are enabled.

REST Service Connection

The address and credentials the service uses to reach the APIEngine. Set the URL, username, and password so the service can authenticate against the APIEngine before doing any work. If the connection or credentials are wrong, the service cannot run its functions and will keep retrying until they are corrected.

Map API3 Stored Procedure Changes in Real-Time

When enabled, the service keeps the API stored-procedure mappings current. Each cycle it checks for procedures that have changed and re-maps them through the APIEngine. If a procedure cannot be mapped, the service reports it by e-mail and notes that the procedure must be corrected and recompiled.

Process IVR via APIEngine

When enabled, the service hands off incoming IVR (automated phone) activity to the APIEngine for processing each cycle.

Process Interactive SMS via APIEngine

When enabled, the service hands off incoming interactive text-message (SMS) activity to the APIEngine for processing each cycle.

Verbose Logging

When enabled, the service writes extra detail to its log. Normally left off to keep the log concise.