Specification

Our APIs use OpenAPI specification, this provides a handful of advantages, to enumerate a few:

• Documentation is automatically updated on every push via the Swagger File, providing to the detailed models & types that are being used in every endpoint
• By navigating to Swagger Editor website, you will be able to pase the Swagger File and get a user friendly interface to understand what endpoints can be used and how
  
• Given a Swagger File that you want to interact with, you can, with a few clicks, generate a working client to consume our APIs, reducing dramatically the development effort, you can generate the client in almost every language you need:
  

Warming up

Before invoking any of our APIs, you will need an Access Token. The token is what makes our APIs secure, by ensuring every call went through authentication. For details about how to get a token, please navigate Here

Common use cases

In this section, we will how to interact with the different endpoints in order to accomplish some use cases that are often needed
We will show POSTMAN screenshots to ilustrate each required invocation

Create or Update an Individual

A common scenario is to push Individual information to Aristotle, and there is often the need to know if that record already exist in 360 or not. If the record exists, then you will need to update, if not, you will need to create. For this use case, we need both Token Service and Individual Microservice

1. Generate a Token

   Make sure you first go to that section and have all your credentials handy

   
   If credentials are valid and your IP Address is whitelisted, you will receive a an Access Token in the response.

2. Checking if your Individual exists

   Given a source ID (for this case DEMO_SOURCE_OM), we want to check if that Individual already exists in 360:
   
   In the response, you can see Individual was not found, so we need to create it

3. Create the record in 360

   This is the minimum we can send to the API to create an Individual:
   
   With the response, make sure to save the individualGuid property, since this is the identifier in 360 for that Individual. You can use this later for other endpoints, like adding Groups to the created individual or update it.

4. Update the record in 360

   If, as a result of #2, we get that the Individual exists, like following:
   
   We will need to update it, in this case we will add Work Address.
   
   You will know if Individual was updated successfully, based on the response.