Surpass OAPI

The Surpass OAPI section of the Surpass Help Site is where you can find useful information about the capabilities of the Surpass OAPIs and reference documentation for all of the Surpass OAPI endpoints. The Surpass OAPI is a more performant, scalable, and flexible REST API primarily for integration with the Item Authoring module of the Surpass Platform.

This page gives an overview of the Surpass OAPI section of the Surpass Help Site.

In this section

Surpass OAPI Basics

The OAPI Basics section explores what the Surpass OAPI is and what the benefits of integrating with it are. This includes information about what makes up a request to and a response from the Surpass OAPI, and how to authorise requests to it. You will also learn how to use the Surpass OAPI Swagger console.

Surpass OAPI Reference

The OAPI Reference section contains comprehensive reference documentation for every API available for the Surpass OAPI. Each endpoint, parameter, property, and error code, including sample requests and responses, are all provided for every API resource to help you request and receive the information you need from the Surpass OAPI.

NOTE: This form is to provide feedback to help improve the Surpass Help documentation only. If you need live support, contact support@surpass.com.