Developer guide. VMS
The Developer guide section provides detailed information about the VMS API, designed for integration and interaction with the VMS system. This section describes the fundamental principles of the API operation, available methods, and examples of their use. Detailed request and response schemas will help developers quickly master the API and effectively utilize its capabilities.
Overview of the section
On the following pages, you will find detailed information on how to use the VMS API.
Product release versions
This section explains how and when new product versions are released.
VMS API essentials
Authentication and access to API.
Request headers.
Language settings. The VMS API may support localization, allowing clients to specify the language of the data returned in responses.
Validation. Status codes for request processing: a detailed description of HTTP codes and their meanings, indicating successful responses or errors.
Pagination – a section on how to work with paginated responses.
API methods
This section outlines the API methods available for interacting with the VMS system. For ease of use, these methods are organized into thematic blocks, each beginning with introductory information. Subsequent navigation pages within each block are presented alphabetically. Furthermore, within each thematic section, requests are ordered by HTTP method: POST, GET, PUT, PATCH, and DELETE.
The Integration API and VMSMobileSDK documentation is publicly accessible.
Other blocks of the API documentation are provided upon request.
The documentation thematic blocks:
Integration API: Designed to enable robust connectivity, this API outlines the requests and responses for integrating the VMS platform with various external systems. Examples include billing, CRM, and telecommunications provisioning platforms.
VMSMobileSDK: This section contains methods specifically designed for the mobile application.
VMS Admin: Requests and responses related to system administration, user management, and settings. The documentation is provided upon request.
VMS Client: Requests and responses used by client applications for data retrieval and operation execution. The documentation is provided upon request.