Quick Start

Complete these tasks to set up your environment and use the REST API for Oracle Communications Unified Assurance Vision.

Prerequisites

Prerequisite More Information
Install Unified Assurance. Installation Guide
Install Vision by deploying the Vision microservices. Vision Installation Overview
Set up authentication for the REST API if needed for additional users. Authenticate

Task 1: Obtain account information

Obtain the following from your system administrator:

  • BundleCA.crt: The bundle certificate.
  • User-<user>.crt: The certificate for the user you will access the API with. The default User-api.crt for the api user is automatically generated.
  • User-<user>.key: The key for the user you will access the API with. The default User-api.key for the api user is automatically generated.

On a Unified Assurance system, these are typically located in the <UA_home>/etc/ssl directory, where <UA_home> is the directory where you installed Unified Assurance. This is typically /opt/assure1, represented by the $A1BASEDIR environment variable.

Task 2: Send a request

Send a simple ping request using cURL to ensure that your connection works:

curl -X GET https://<hostFQDN>:9443/vision/api/ping

where <hostFQDN> is the server where the API is running.

The API will return a message that includes the release number. For example, Version 6.1.0.0.0-RELEASE running.

Send a request that requires authentication to ensure that your credentials are set up properly. For example, to send a request as the api user to see general Vision settings, such as the default latitude, longitude, zoom, and refresh rate: 

curl --cacert $A1BASEDIR/etc/ssl/BundleCA.crt --cert $A1BASEDIR/etc/ssl/User-api.crt --key $A1BASEDIR/etc/ssl/User-api.key -X GET https://<hostFQDN>:9443/vision/api/generalSettings

The API will return a JSON object containing the general settings, with content similar to the following:

{
    "content": [
        {
            "id": 1,
            "name": "Default Latitude",
            "value": "53.450000",
            "type": "number",
            "min": -90,
            "max": 90
        },
        {
            "id": 2,
            "name": "Default Longitude",
            "value": "-7.960000",
            "type": "number",
            "min": -180,
            "max": 180
        },
        {
            "id": 3,
            "name": "Default Zoom",
            "value": "7",
            "type": "number",
            "min": 0,
            "max": 20
        },        
        {
            "id": 4,
            "name": "Default Refresh Rate",
            "value": "60",
            "type": "number",
            "min": 60,
            "max": 86400
        },
...

Note:

To send a request as a different user or using certificates stored in a different directory, use the certificate and key generated for that user or directory.