AudioCodes Mediant 500 MSBR, Руководство пользователя

Страница: 113 / 1248

Version 7.2 113 Mediant 500 MSBR
User's Manual 12. REST-Based Management
12 REST-Based Management
You can manage the device through the Representational State Transfer (REST)
architecture. REST is a Web-based access service, allowing you to access the device's
management interface over HTTP/S. Developers can use the device's REST API to
integrate the device into their solution and allow administrators to perform management
and configuration tasks through automation scripts.
The REST API relies on a simple pre-defined URL path ( < device's OAMP IP address
>/api/v1 ) through which device resources can be accessed. Each resource represents a
specific device management element (e.g., file upload), state object (e.g., alarms), or
maintenance action (e.g., reset). The REST API uses the standard HTTP/1.1 protocol.
Standard HTTP methods (GET, PUT, POST and DELETE) are used to read the resource’s
state and to create, update, and delete the resources, respectively. Resource state is
described in JSON format and included in the HTTP request or response bodies. For
security, it is recommended to secure REST traffic by using HTTPS.
The figure below displays an example of accessing the device’s active alarms through
REST, using a standard Web browser. To facilitate your understanding of REST, the
example shows each navigation step to the active alarms resource; however, you would
typically access the active alarms resource directly using its full URL path (i.e.,
/api/v1/alarms/active ).
Figure 12-1: Accessing Device's REST Interface via Web
Figure 12-2: REST Resource - Alarms