Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > User Documentation > Aria6 API

Aria6 API

Overview

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

Aria6 API List.png

API Categories

Core API

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

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.

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.

Making API Calls

Core and Object Query APIs can be called through SOAP and REST. Admintools APIs can only be called using REST.

Each API request is authenticated using a combination of the <client_no> and <auth_key> parameters.

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. 

Note: Due to the nature of a multi-tenant environment and the high number of API calls that Aria receives, do not make more than 8 concurrent calls. If you have a business need to submit more than 8 concurrent calls, submit a support ticket in advance. This ticket must include the expected number of concurrent calls, as well as the session start and end times, so that Aria can more closely monitor API traffic.

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. You can paste the endpoint URLs from the table below into your client application. 

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

If you are using two-way SSL to call APIs, see Two-Way SSL Certificates for those endpoints. If you are not using two-way SSL, use the endpoints below. 

Environment API Category Endpoint URL
Stage Future PHL Core API https://secure.future.stage.ariasystems.net/api/ws/api_ws_class_dispatcher.php
Object Query API https://secure.future.stage.ariasystems.net/api/AriaQuery/objects.php
Admintools API https://admintools.future.stage.ariasystems.net/AdminTools.php/Dispatcher
Stage Future EUR Core API https://secure.future.stage.cph.ariasystems.net/api/ws/api_ws_class_dispatcher.php
Object Query API https://secure.future.stage.cph.ariasystems.net/api/AriaQuery/objects.php
Admintools API https://admintools.future.stage.cph.ariasystems.net/AdminTools.php/Dispatcher
Stage Current PHL Core API https://secure.current.stage.ariasystems.net/api/ws/api_ws_class_dispatcher.php
Object Query API https://secure.current.stage.ariasystems.net/api/AriaQuery/objects.php
Admintools API https://admintools.current.stage.ariasystems.net/AdminTools.php/Dispatcher
Production Core API https://secure.ariasystems.net/api/ws/api_ws_class_dispatcher.php
Object Query API https://secure.ariasystems.net/api/AriaQuery/objects.php
Admintools API https://admintools.ariasystems.net/AdminTools.php/Dispatcher
You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.