API v2 Basics
The API v2 Basics section of the Surpass Help Site is the perfect introduction to users unfamiliar with the Surpass API v2, and includes information on what the Surpass API v2 is, what its capabilities are, and how to get started with it.
This page gives an overview of the API v2 Basics section of the Surpass Help Site.
In this section
About the Surpass API v2
The About the Surpass API v2 article explores what the Surpass API v2 is, the benefits of integrating with it, and other useful technical information to help you understand how your resources can relate to it. This includes a table detailing each state a test session can pass through in the Surpass system.
Getting started with the Surpass API v2
The Getting started with the Surpass API v2 article demonstrates what makes up a request to and a response from the Surpass API. You will also learn what the Surpass API v2 test console is and how to access it.
Connecting to the Surpass API v2
The Connecting to the Surpass API v2 article explains how to authorise requests to the Surpass API. This page also details each permission the user sending a request to a Surpass API needs to have for the request to be successful.
Using the Surpass API v2 reference documentation
The Using the Surpass API v2 reference documentation details what the API v2 Reference documentation includes and how best to read it. You will also learn what Postman is and how to make use of the Surpass Platform Postman Workspace.
Using the Surpass API v2 test console
The Using the Surpass API v2 test console article explains what the Surpass API v2 test console is and contains instructions on how to use it. The Surpass API v2 test console can be used to test the Surpass APIs.