Skip to main content

Rest API

Overview​

The Atria REST API provides a comprehensive set of endpoints that enable developers to integrate and automate tasks within the Atria platform. It supports a wide range of functionalities, including user management, service provisioning, subscription management, and reporting. Built on modern REST standards, the API ensures secure, scalable, and efficient communication between external applications and Atria’s core services.

This guide will show you how to setup and use the API, and then move on to an index linking to the various capabilities of the API.

Setting Up the API​

The Rest API resides on the AtriaWeb server and runs as Atria ExternalAPI. You can use IIS to check the binding and find the URL you need to access the API:

Rest API Setup

In this example, the URL is https://atriaweb:8097.

Alternately, you can access the API by heading to https://{atriahost}/api.

  • From a browser window, enter the URL and you will be presented with the below:

Rest API Setup

  • You can use the dropdown menu in the top right to switch between different categories:
Rest API Setup
  • These pages display the available functions/ methods you can use:

Rest API Setup

  • You can run and test the available functions directly from the browser, however to do this, you need to authorize yourself:
Rest API Setup
  • Click the Authorize button to be prompted for an oauth2 key:
Rest API Setup
  • Login to the Atria platform with either Service Provider Administrator or Service Provider Developer permissions.
  • Navigate to My Account:
Rest API Setup
  • Open the API Tokens page:

Rest API Setup

  • Click Generate:

Rest API Setup

  • This will generate you an API Token. This token will only be shown once, and will have an expiry which is shown in the record below:

Rest API Setup

  • You can also use this page to delete tokens that are no longer in use:

Rest API Setup

  • Enter the token into the API authorization box and click Authorize. This will unlock the browser interface:
Rest API Setup

Using the Browser Interface​

Each API function specifies its action and has a small description of what it does:

Rest API Setup
  • Click on the arrow to reveal the parameters associated with the function.
  • Click Try it out to unlock the parameters and allow you to test the function:

Rest API Setup

  • The following example retrieves the customer with the CustomerID of 4:

Rest API Setup

  • In the responses section, you will see the Curl request, the Request URL, and the Response Body:

Rest API Setup

API Endpoints​

Navigate through the sections below to to see how to use, and view specifications about the various API functions available.