Docs for all releases
Page History
...
Provisioning API provides a mechanism for real-time integration with 3rd party systems, including softswitches, gateways, and CRM systems. It calls calls pre-defined handlers on an the 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:
|
...
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:
...
Field | Description | |
---|---|---|
Name | Specify a particular title for a handler | |
Event | Specify a handler event from the following list: | |
Clients |
| |
Accounts |
| |
Subscriptions |
| |
Import |
| |
Status | Choose the state of the handler:
| |
Priority | Establish an order of handler performing. |
...
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:
...
language | py |
---|
...
. |
...
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
To put a handler into action, you need to wait for about 5 minutes till the next execution of the Cache Manager service. |
...
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Warning Please note, the Provisioning functionality is experimental and may be changed completely subject to change in future releases. |