Key Elements for Unified CVP APIs
This section identifies the key elements and patterns within a Unified CVP API.
Sample URL for a Unified CVP API:
https://<host>:<port>/cvp-config/<sampleservice>/<samplemethod>
Element | Description |
|---|---|
https:// | HTTPS is the secure protocol used by Unified CVP API. |
<host>:<port> | Replace <host> with the hostname and <port> with the port number. These two elements are part of the context root for each API. |
cvp-config | This is the web service that provides the REST APIs according to the REST standards. |
sampleservice | This is the name of the service being addressed by this Unified CVP API. In this element, sampleService is the interface and sample is the implementation. |
samplemethod | This is the API name. Each API name begins with a verb to indicate the action being performed. |