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

Prior to that, VCS Core API and Management API provide utilities needed to receive requests from external systems. Now, you can configure VCS billing platform to send requests to your 3rd party system.

For example, you can monitor the client's balance status via this functionality. Thus, when the client's balance is below zero, you can configure that the billing will send to an external system a notification in order to avoid any disruptions to your organization current processes.

Tip

The full list of Provisioning API parameters matches with CoreAPI and they are available upon an individual request of your current clients.

Handlers

Best practice example

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

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

1. 1. Specify the name, type, and status.
   2. In Event field select Clients Create event from the drop-down list.
   3. In 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:

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()