Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Provisioning API provides a mechanism for a 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.

...

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

Button/IconDescription

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

...

Panel
borderColor#ccffcc
bgColor#ccffcc
borderWidth2px
borderStylesolid
Tip

For a quick switch between enabled and disabled statuses, click on a respective status icon in the section. However, to change archived status, you need to do it from a hander handler edit form

Advanced Search

Advanced Search drop-down menu, located in the top right corner of the section, is called to facilitate an easy access to required informationBy clicking on on a red downwards arrow  iconthe following drop-down menu is displayed:

...

FieldDescription
Event

Select from a list of all possible handler events

Handler Type

Indicate a type of handler:

  • scripthttp
Status

Choose a target status:

  • Enabled
  • Desabled
  • Archived

or leave this field blank. In this case, both enabled and disabled handlers will be displayed. This field is empty by default


Creating a New Handler

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

...

Panel
borderColor#ccffcc
bgColor#ccffcc
borderWidth2px
borderStylesolid

Best practice example

Here there There is an example based on http://handler usage.

2. Open the Provisioning section and start to create creating a handler.

    1. Specify the name, type, and status.
    2. Inthe Event field, select Clients Create event from the drop-down list.
    3. Inthe Task field, indicate http:// type and determine the port and method, for example: 120.0.0.1:5000/api.
    4. Click Apply.

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

Code Block
languagepy
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
borderWidth2px

(warning)   Attention

In order to To put handler into action, you need to restart Cache Manager. To do so, click on corresponding icon in Task Scheduler section

...