Atria API Policy

Atria API Policy

Purpose 

To provide direction and guidance to Atria customers and third parties integrating with Atria API’s. 

Atria API's


API Name
Type
Purpose
Cortex API
XML based over HTTPS https://{hostname}/cortexapi 
Used by AD Sync, Customer, User, Service Provisioning
Atria API
JSON/REST https://{hostname}/api
Billing API, Microsoft NCE License Management

API Direction

  1. The CortexAPI will continue to be supported for all existing services and custom services and for ADSync capability for the foreseeable future. 
  2. The CortexAPI at present is the primary API for integration and automation of Atria.   
  3. The Atria API will be the primary API for new development.  All new API’s will be added to the Atria API, unless there is a specific reason we need to add it to the CortexAPI. 

Notice of Changes to API’s 

  1. Where possible, breaking changes will be avoided (a change to an existing API which would require a change to code using that API) 
  2. If we must make a breaking change to an API we will advise in the release notes of the change and provide at least 2 weeks notice before the release is available   
  3. If we plan to deprecate any part of an API, we will give you at least 3 months' notice of such a change.   

Deprecation of Cortex API 

Modernization of the Atria platform will eventually lead to the replacement of all required API functionality into the new Atria API.  When we are able to foresee it being possible to fully deprecate the Cortex API and choose to deprecate the Cortex API, we will provide at least 6 months' notice. 



    • Related Articles

    • Atria API

      Atria API Purpose The Atria API is a new Rest-based integration point that over time will replace the functionality of the old API, (known as the CortexAPI). If you have developed against The CortexAPI, don’t worry, it’s still working and supported. ...
    • How to connect Power BI to Atria API

      Overview In this article, we are going to show you how to connect to Atria API via Power BI.  Power BI will be able to retrieve data to create visuals and reports based on your requirements. The following article will illustrate a step by step guide ...
    • Atria API User Guide (CortexAPI)

      Overview The application programming interface (API) is a powerful interface that allows you to interact directly with Atria without using the ATRIA Web User Interface (UI).  The API grants a user, with some development knowledge, the ability to ...
    • Atria Billing Setup User Guide

      Objective This article describes how to configure Atria to utilize the latest billing features. This document outlines the billing setup attributes that should be configured.    Applies to Introduced in Atria version 12.0.0 Billing Setup Overview To ...
    • Creating an Autotask API User for Atria

      Introduction In order to configure Atria to update Contracts in Autotask, you need to generate an API user and obtain the API username and password. This article takes you through the steps of setting up a Security Level and a new user. 1. Set up a ...