2017-1Q: SIMPLer: Triggered Callback - SIMPLer API
A new feature has been added that will allow Operators to call back the SIMPLer API using the Triggers functionality. This means that on a particular trigger enabled you could call a SIMPLer API function.
NOTE: At the beginning only "Customer Auto-Payment Change" trigger is supported but it could be enhanced with future requests from operators.
In order to set it up operators must:
(1) Request SIMPLer API Username & Password for triggers - contact firstname.lastname@example.org to ask for API credentials.
(2) Go to Settings -> External API (triggers). (See Fig. 1).
Fig. 1: Settings - External API Triggers
(3) Click "Add Blank Row" and from the list select "SIMPLer API". (Fig. 2).
(4) Fill in the Settings below (Fig. 2).
Fig. 2: Trigger EndPoint Definitions.
The following rules apply:
Base_URL - it must be the URL of the rest API of the SIMPLer server you use.
Customer_AutoPayment_Change_Action - consists of 3 elements separate by space:
POST_METHOD API_ENDPOINT API_PARAMS
POST_METHOD (one of the following):
DELETE - used by "delete" functions of the API
POST - used by "add" functions of the API
PUT - used by "modify" function of the API
endpoint of the API
all params supported by the given functions. They can be separated by "&" character. It is possible to take the param value from the triggered call. A list of the params values from the triggered call available can be found at the bottom of this page
Customer_AutoPayment_Change_Condition - defines the condition under which the API is called. Only params from the triggered call can be used here. If the value of all of these params meets the condition specified the SIMPLer API call is executed. They can be separated by "&" character.
api_username & api_password - provided by azotel support to enable SIMPLer API.
LIST OF PARAMS/VALUES CURRENTLY AVAILABLE
Trigger: Customer Auto-Payment Change:
%CUSTOMERID% - takes the value of "customerid" param