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 comprises API calls 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.
Guides for Core API calls include links to specifications formatted on SwaggerHub.
Object Query API
The Object Query API category comprises API calls 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.
Guides for Object Query API calls include links to specifications formatted on SwaggerHub.
Admintools API
The Admintools API category comprises API calls 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 comrprises API calls 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.