Provisioning API

Owned by Kiss, Mate
Feb 26, 2024

Overview

This web services API allows service providers to automatically create users and tenants. The interface is implemented using Web Services.

API Configuration

Please follow the guidelines below to configure the Verba Provisioning API.

Step 1 - Login to the web interface with System administrator rights.

Step 2 - Navigate to the Administration / Verba Servers menu item and select your server from the list.

Step 3 - Click on the Change Configuration Settings link (2nd tab from left)

Step 4 - Navigate to the Web Application / Provisioning API node.

Step 5 - Fill out the configuration according to the requirements in the following table.

Configuration item
Description
Web Service URL Template

The default value is: http://0.0.0.0:{port}/provisioning

You can specify on which interface and URI should Verba listen on. The default 0.0.0.0 means that we listen on all interfaces for incoming requests.

Web Service Version(s) to be Started

The default value is: 1

Available versions are 0, 1, 2 and 3.

You can specify more than one version with a comma like so: 1,2,3. Configuring multiple versions will result in multiple TCP ports.

Web Service Port Range Start

The default value is: 7000

For each version, the port value is fixed. For example:

  • API version 0 = 7000 (Web Service Port Range Start value + 0)
  • API version 1 = 7001 (Web Service Port Range Start value + 1)
  • API version 2 = 7002 (Web Service Port Range Start value + 2)
  • API version 3 = 7003 (Web Service Port Range Start value + 3)

Step 6 - Hit the save icon  and restart the Verba Web Application Service on the Media Repository Server so the new settings can take effect.

API versioning

The Provisioning API provides a version control mechanism. Different versions of the API can coexist on the same recording platform through different TCP ports. When a new version of the API becomes available it gets deployed on the next available TCP port without interfering with earlier versions.

For detailed information regarding each Provisioning API version please follow the links below:

Security

The API provides the following mechanism to ensure that access to the API is secure:

    • User-based authentication - you can create different API users for different projects
    • Token based sessions - use requestToken to receive a temporary session token
    • Separate provisioning port - You can use TCP port filters to restrict access to the API