APIs

mark.thompson@oneadvanced.com Updated by mark.thompson@oneadvanced.com

APIs can be used to access and change data that is within the system. Giving a Person or Company access to your APIs is the same as giving them access to you system - all usual polices and procedures should be followed when considering

API Help

The API Help library can be found in Settings > Customizations > API Routes. This contains information about each API available including sample pay loads, types of calls which can be made and API Definitions for download.

API Routes

API Routes can be seen in Settings > System Management > API Routes. This controls which APIs are available for this Tennant.

If the API Route required is not already made it can be added either via the API Help using the "Add to API Routes Button" as shown below or manually within API Routes . T do this Choose any 'Name' you would like andthe 'Route' must match the 'Path' shown in the API Help.

The 'Path': from API Help and "Add to API Routes" button:

Using the 'Path' to create the API Route:

API Applications

Applications can be found in Settings > System Management > Applications.

The Applications are used to control the credentials which the API will be using. It is recommended to set up a new Application per System being integrated.

When setting up the Application a 'Application User' has to linked which the Integration will act as when accessing and changing data. This user will be used in the audit and its recommended to set up a new user and team for each Application, as shown in the examples below.

System Users Creation

In this example the System to be integrated is named Tribepad

Application Creation

In this example the System to be integrated is named Tribepad. When saved the 'Authentication' key is automatically created. The 'Secrets' must be created by clicking the 'Secrets' tab and the 'Plus' sign. When doing this a Secret Key will appear on screen and will not be shown again. Therefore this must be saved in a secure place for the next step.

The API Routes must be added to the Application which controls which API Routes are allowed per Application.

Calling the APIs

Using API Applications such as Postman the above information can be used to call the APIs.

Using Postman as an example it requires the following information in the Variables tab:

  1. Client_Id - from Settings > System Management > Applications > Application Key
  2. Client_Secret - as described above when setting up the Application
  3. Auth_ulr - the URL of the System you are connecting to
  4. Service_url - if connecting to a test environment on Non-Production (controlled by OneAdvanced for development and testing) this will be https://integration-api-qa.advancedcarecloud.oneadvanced.io/api. If connecting to a Production environment (this includes Customer UAT/TEST/PROD/LIVE) this will be https://integration-api.advancedcarecloud.com/api.

Calls can then be made with the Collections area. In the example below a System User (where Payrollid is 12345) is being retrieved from the system using an API.

Was this article useful?

Contact