Home > Aria Crescendo Documentation > Configuration > Web Service API

Web Service API

Overview

To make API calls to Aria, you must whitelist the IP addresses from which you make API calls. If you make an API call from an IP address that is not whitelisted, you encounter an authentication error.

For an explanation of Aria IP addresses, see Aria IP Ranges.

Note: To maintain the security of your system, it is recommended that you restrict access to Web Service API to your Administrator only.

View Your Client Number and Authorization Key

Getting Here: Click Configuration > Integrations > Web Service API

You will need your client number and Authorization Key (auth key) to make API calls to Aria. Your client number and auth key are displayed at the top of the Web Service API screen as shown below:

web_service_api_config_0.jpg

Add Whitelisted IP Addresses

Getting Here: Click Configuration > Integrations > Web Service API

  1. Click New.

    Create_New_User_0827c.png

  2. In the Starting IP field, enter the first IP address in the range.
  3. In the Ending IP field, enter the last IP address in the range.
  4. From the Valid for API drop-down, select Yes or No to specify that core API methods can be called from this range of IP addresses.
  5. From the Valid for SSO drop-down, select Yes or No to specify that SSO API methods can be called from this range of IP addresses.
  6. From the Valid for Admin/Config drop-down, select Yes or No to specify that Aria API methods can be called from this range of IP addresses.
  7. From the Valid for Object Query drop-down, select Yes or No to specify that object query API methods can be called from this range of IP addresses.
  8. From the Valid for Access Control APIs drop-down, select Yes or No to specify that access control API methods can be called from this range of IP addresses.
  9. In the Description field, enter an explanation to describe what the range of IP addresses applies to (such as "API call testing).
  10. Click Save.

A sample Web Service API grid appears below.

Web_Service_API_0826f.jpg

Last modified

Tags

Classifications

This page has no classifications.
Powered by CXone Expert ®