Advantus uses REST APIs within its resource-oriented architecture while supporting HTTP request, response, and authentication codes.

The response codes include POST, GET, PATCH, PUT, and DELETE. It leverages the JSON format for seamless authentication, data interchange, and 2-factor authentication for added security.

This document details how to use these APIs to integrate Advantus with various applications. By the end of the document, you will understand :

What a successful response for an API call looks like :

HTTP Status CodeStatusDefinition
200OKThis response code is used to show that the request was successful
201CreatedThis response code shows that the request has been fulfilled, which results in the creation of a new resource
204No ContentThis response code indicates that the server has successfully fulfilled the request and that there is no content to send in the response payload body.

The logic and concepts behind the APIs:

sequenceDiagram

REST Clients->>+REST Server: REST Request (HTTP Method + URI) GET, PUT, POST, DELETE

REST Server->>-REST Clients: REST Response (resource representation in JSON and XML)

The most commonly used methods for integration are:

  • Php
  • Python, etc. (REST API for now)

You can test and debug our APIs using tools like Postman, cURL, and REST-Assured. You can access various response codes by selecting the respective code library below.