Page History

Panel

title	In this article

Table of Contents

Section overview

The following section allows configuring and monitoring of hooks for Provisioning API.

Provisioning API provides a mechanism for real-time integration with 3rd party systems, including softswitches, gateways, and CRM systems. It calls pre-defined handlers on an occurrence of specific events in the system. The handlers are allowed to modify data, forbid or allow the action or simply process given event.

For detailed information about Provisioning API functionality, go to the APIs section of our User Guide.

To configure handlers and check their call log, go to the Integration > Provisioning API.

Column	Description
ID	Handler's identification number
Priority	Priority of handlers execution
Name	Handler's title
Event	Description of the handler event
Handler	Category of the handler that is used and location. There are two types of handlers that can be used: HTTP scripts, called via POST requests (used in most cases) Local server scripts, called locally on the server (used in very specific cases)

The list of section functional buttons/icons is as follows:

Button/Icon	Description
	Allows creating a new handler
	Identifies a disabled status of a handler
	Identifies an enabled status of a handler
	Identifies an *archived* status of a handler
	Allows viewing details of a target handlers' performance Execution Logs tab for a respective handler
	Allows deleting a handler from the system

Advanced Search

Advanced Search drop-down menu, located in the top right corner of the section, is called to facilitate easy access to required information. By clicking on a red downward arrow icon, the following drop-down menu is displayed:

Field	Description
Event	Filter by the event type
Handler Type	Filter by the type of the handler
Status	Filter by status of the handler

Creating a New Handler

To start with provisioning, you need to create a handler manually. Click the New Handler button and specify respective parameters in the appeared pop-up window:

Screenshot: Provisioning section/Handler adding form

Field	Description
*Name*	Specify a particular title for a handler
Event	Specify a handler event from the following list:
	Clients	create update delete archive custom fields update balance became >=0 balance became <=0
	Accounts	create update delete
	Subscriptions	assign activate deactivate renew close
	Import	import process failed import process success
Status	Choose the state of the handler: enabled - select it to make a handler active; disabled - select it to unable a handler; *archived* - select it to archive a handler.
Priority	Establish an order of handler performing. Note: The handler with *1 priority* will precede all other handlers in order.

Panel

borderColor	#ccffcc
bgColor	#ccffcc
borderWidth	2px
borderStyle	solid

Best practice example

There is an example based on https://hostname/handler-endpoint usage.

Open the Provisioning section and start creating a handler.

Specify the name, type, and status.
In the Event field, select Clients Create event from the drop-down list.
In the Task field, indicate HTTPS type and define the URL for the handler, for example, my-domain.org/api.
Click Apply.

Find an example of the http://handler below:

Code Block

language	py

from flask import Flask, request
import json
app = Flask(__name__)
@app.route("/api", methods=['GET', 'POST'])
def api():
    data = json.loads(request.data)
    return json.dumps(data)
if __name__ == "__main__":
    app.run()

Panel

borderColor	#ffffb3
bgColor	#ffffb3
borderWidth	2px

Attention

To put a handler into action, you need to wait for about 5 minutes till next execution of the Cache Manager service.

Execution Logs tab

You can access the details about handler execution in this tab. For more details, check out a related article: Execution Logs.

Panel

borderColor	#FFBABA
bgColor	#FFBABA
borderWidth	2px
borderStyle	solid

Warning

Please note, the Provisioning functionality is experimental and may be changed completely in future releases.

Versions Compared

Old Version 5

New Version 6

Key

Section overview

Execution Logs tab