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:
- 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."
- 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”.
- 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.”
- 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).”
- 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.