Making API Calls

Last updated
Save as PDF

Special Note for Aria Multi-Tenant Customers

We built the Aria environment to scale horizontally, providing the flexibility to handle your evolving demands. In our multi-tenant environments, there are inherent limitations in place that are required to keep the database stable. We tune these limits as our clients provide capacity growth projections throughout 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 requires a higher number, please communicate via a support ticket prior to executing, or consult with Aria Professional Services. This will allow Aria to accommodate 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.

Formatting Dates in API Calls

All dates should be passed in this format: YYYY-MM-DD.

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.

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/v1/core
	Object Query API	https://secure.future.stage.ariasystems.net/api/AriaQuery/objects.php
	Admintools API	https://admintools.future.stage.ariasystems.net/AdminTools.php/Dispatcher
	Access Management API	https://secure.future.stage.ariasystems.net/crescendo/access-management
Stage Future AUS	Core API	https://secure.future.stage.aus.ariasystems.net/v1/core
	Object Query API	https://secure.future.stage.aus.ariasystems.net/api/AriaQuery/objects.php
	Admintools API	https://admintools.future.stage.aus.ariasystems.net/AdminTools.php/Dispatcher
	Access Management API	https://secure.future.stage.aus.ariasystems.net/crescendo/access-management
Stage Future EUR	Core API	https://secure.future.stage.cph.ariasystems.net/v1/core
	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
	Access Management API	https://secure.future.stage.cph.ariasystems.net/crescendo/access-management
Stage Future SGP	Core API	https://secure.future.stage.sgp.ariasystems.net/v1/core
	Object Query API	https://secure.future.stage.sgp.ariasystems.net/api/AriaQuery/objects.php
	Admintools API	https://admintools.future.stage.sgp.ariasystems.net/AdminTools.php/Dispatcher
	Access Management API	https://secure.future.stage.sgp.ariasystems.net/crescendo/access-management
Stage Current PHL	Core API	https://secure.current.stage.ariasystems.net/v1/core
	Object Query API	https://secure.current.stage.ariasystems.net/api/AriaQuery/objects.php
	Admintools API	https://admintools.current.stage.ariasystems.net/AdminTools.php/Dispatcher
	Access Management API	https://secure.current.stage.ariasystems.net/crescendo/access-management
Stage Current AUS	Core API	https://secure.current.stage.aus.ariasystems.net/v1/core
	Object Query API	https://secure.current.stage.aus.ariasystems.net/api/AriaQuery/objects.php
	Admintools API	https://admintools.current.stage.aus.ariasystems.net/AdminTools.php/Dispatcher
	Access Management API	https://secure.current.stage.aus.ariasystems.net/crescendo/access-management
Stage Current EUR	Core API	https://secure.current.stage.cph.ariasystems.net/v1/core
	Object Query API	https://secure.current.stage.cph.ariasystems.net/api/AriaQuery/objects.php
	Admintools API	https://admintools.current.stage.cph.ariasystems.net/AdminTools.php/Dispatcher
	Access Management API	https://secure.current.stage.cph.ariasystems.net/crescendo/access-management
Production	Core API	https://secure.ariasystems.net/v1/core
	Object Query API	https://secure.ariasystems.net/api/AriaQuery/objects.php
	Admintools API	https://admintools.ariasystems.net/AdminTools.php/Dispatcher
	Access Management API	https://secure.prod.cph.ariasystems.net/crescendo/access-management
Production AUS	Core API	https://secure.prod.aus.ariasystems.net/v1/core
	Object Query API	https://secure.prod.aus.ariasystems.net/api/AriaQuery/objects.php
	Admintools API	https://admintools.prod.aus.ariasystems.net/AdminTools.php/Dispatcher
	Access Management API	https://secure.prod.aus.ariasystems.net/crescendo/access-management
Production EU	Core API	https://secure.prod.cph.ariasystems.net/v1/core
	Object Query API	https://secure.prod.cph.ariasystems.net/api/AriaQuery/objects.php
	Admintools API	https://admintools.prod.cph.ariasystems.net/AdminTools.php/Dispatcher
	Access Management API	https://secure.prod.cph.ariasystems.net/crescendo/access-management