OAPI Basics
The OAPI Basics section of the Surpass Help Site is the perfect introduction to users unfamiliar with the Surpass OAPI, and includes information on what the Surpass OAPI, what its capabilities are, and how to get started with it.
This page gives an overview of the OAPI Basics section of the Surpass Help Site.
In this section
About the Surpass OAPI
The About the Surpass OAPI article explores what the Surpass OAPI is, the benefits of integrating with it, and other useful technical information to help you understand how the available Surpass OAPI resources relate to it.
Getting started with the Surpass OAPI
The Getting started with the Surpass OAPI article demonstrates what makes up a request to and a response from the Surpass OAPI. You will also learn what the Surpass OAPI Swagger console is and how to access it.
Connecting to the Surpass OAPI
The Connecting to the Surpass OAPI article explains how to authorise requests to the Surpass OAPI. This page also details each permission the user sending a request to a Surpass OAPI needs to have for the request to be successful.
Using the Surpass OAPI Swagger console
The Using the Surpass OAPI Swagger console article explains what the Surpass OAPI is and contains instructions on how to use it. The Surpass OAPI Swagger console can be used to test the Surpass OAPIs.