Home > Aria Crescendo Documentation > Aria Crescendo APIs

Aria Crescendo APIs


Aria provides a comprehensive suite of APIs, grouped into logical categories, based on their method. All Aria APIs can be found on Developer Central.

Note: For SOAP and REST calls, the POST method is supported. The GET method is not supported.

API Categories

Core API

The "Core API" category contains APIs that are generally used to work with accounts, account transactions, configuration, and billing interactions.

The supported formats for calling the Core APIs are:

  • REST (application/json);
  • REST (application/x-www-form-urlencoded); and
  • SOAP.

Note: The following lists several use cases that will return different error codes/messages based on recent API performance improvements: 

  1. If an input parameter is a "long" and the input value provided is not a valid "long," the APIs will return error code 1016 and error message saying " (parameter name) is not a valid long." 
  2. If the client_no input parameter is passed as a very long number, the APIs will return error code 1012 and error message "Unable to parse input json - invalid format.” The previous behavior was an error code 1004 and error message “authentication error”.
  3. If the acct_no input parameter is passed as a very long number the APIs will return error code 1012 and error message "Unable to parse input json - invalid format.” The previous behavior was an error code 1009 and error message “account doesn’t exist.”
  4. For REST calls, if any input array parameter is passed in the format “array_name[parameter_name][0]”  (e.g., order_line_items[client_sku][0]), the API will return  error code 1016 with error message “(parameter name) is not a valid string.” The previous behavior was an error code 1010 and error message “Missing required parameter: (parameter_name).”
  5. For REST calls, if any input array parameter is passed in the format “[array_name][index][parameter_name]”  (e.g., [order_line_items][0][client_sku]), the API will return error code 1012 with error message “Unable to parse input : Invalid format for [array_name][index][parameter_name].” The previous behavior was an error code 1010 and error message “Missing required parameter: (parameter_name).”

Object Query API

The "Object Query API" category contains APIs that are used to query and get multi-row feedback across accounts, or to extract client product catalog or marketing information.

The supported formats for calling the Object Query APIs are:

  • application/x-www-form-urlencoded; and
  • SOAP.

Admintools API

The "Admintools API" category contains APIs that deal with managing a client's product catalog and marketing activities including the ability to create, modify, and delete objects.

The supported format for calling the Admintools APIs is application/x-www-form-urlencoded.

Access Management API

The "Access Management API" category contains APIs that deal with managing users in your Aria instance, including the ability to create, modify, and delete users. The supported format for calling the User Access APIs is REST (application/json).

TM Forum Open API

The TM Forum Open API & ODA model is designed to replace traditional operational and business support systems (OSS/BSS) architectures and become the de facto standard for open platforms, allowing communication service providers (CSPs) to digitally transform and reduce software procurement, integration, and development inefficiencies. The supported format for calling the TM Forum Open APIs is REST (application/json). Learn more about Aria's TM Forum Open API initiative.

Making API Calls 

Each API request is authenticated using a combination of the <client_no> and <auth_key> parameters. In lieu of the <auth_key>, you can also use a client certificate for authentication.

Special Note for Aria Multi-Tenant Customers

The Aria environment is built to scale horizontally providing the flexibility to handle the ever changing demands of our client base. In our multi-tenant environments, there are inherent limitations in place that are required to keep the database stable. These limits are tuned as our clients provide capacity growth projections through-out a given year. We ask our multi-tenant clients to control how many concurrent APIs are sent to ensure stability of the database. As a guide, we suggest 15-20 concurrent calls across all APIs within your instance. If your business needs require a higher number, we ask that this information is communicated through a support ticket prior to executing, or consult with Aria Professional Services. This level of notification will allow Aria to plan for the additional load, and not disrupt the activities of the other clients within this multi-tenant environment. 

Updating API Changes with New Product Releases 

Aria maintains backward compatibility with older versions of the WSDL files (SOAP). However, you do not need to update your REST requests to align with each Aria release since previous API versions continue to function.

  • If you are using SOAP for your Core or Object Query API calls, WSDL files are updated with each release and are included in the release notes.  
  • If you are using REST, any API changes within an Aria release are immediately usable, though not required. 

Endpoint URLs 

An endpoint URL is the URL that is used in the request to call the Aria API web services. In a given environment, the Core API, Object Query API, and Admintools API each have their own endpoint URL.

Below is a list of endpoint URLs for Aria's server environments to be used within your custom code that calls Aria APIs, and they must be tested in the context of code that calls Aria APIs. They are not valid as standalone web addresses and, when called without API data (e.g. pasted into a Web browser's address bar), will result in an error.

Note: The endpoint URLs are also specified near the end of each WSDL file in the <soap:address> element.  

Environment API Category Endpoint URL
Stage Future PHL Core API
Object Query API
Admintools API
Access Management API
Stage Future AUS Core API
Object Query API
Admintools API
Access Management API
Stage Future EUR Core API
Object Query API
Admintools API
Access Management API
Stage Future SGP Core API
Object Query API
Admintools API
Access Management API
Stage Current PHL Core API
Object Query API
Admintools API
Access Management API
Stage Current AUS Core API
Object Query API
Admintools API
Access Management API
Stage Current EUR Core API
Object Query API
Admintools API
Access Management API
Production Core API
Object Query API
Admintools API
Access Management API
Production AUS Core API
Object Query API
Admintools API
Access Management API
Production EU Core API
Object Query API
Admintools API
Access Management API

Last modified


This page has no custom tags.


This page has no classifications.