About the SecureMarker OAPI

The SecureMarker OAPI is a REST API built on the latest .NET Core technologies and adopts the OpenAPI specification (for more information, visit https://www.openapis.org/about), an API standard that is highly performant, scalable, and flexible.

For information on the Surpass OAPI, including data models that demonstrate the different entities that make up the Surpass Platform, read About the Surpass OAPI.

Integrating with the SecureMarker OAPI

Integrating with the SecureMarker OAPI offers many benefits, including the ability to:

• Send and retrieve data whenever you want, meaning you are not restricted to specific time periods.
• Automate your internal processes so that only one master system has to be updated, removing administrative overhead.
• Diagnose any issues using common HTTP errors (401…), simplifying integrations.
• Not be tied to a particular server, enabling a more scalable integration from which you can easily recover from failed requests.

SecureMarker entities

Before using the SecureMarker OAPI, it is beneficial to have an understanding of the way its entities relate to Surpass. The core SecureMarker entity is Test Script.

A script configured for marking in SecureMarker is exported to SecureMarker upon being warehoused in Audit (Test Administration workflow state 13: Archived). Its Warehouse State moves from Warehoused to Awaiting Export to SecureMarker, to Exported to SecureMarker and Result Pending from SecureMarker.

After Surpass receives marking information for the script from SecureMarker, it returns to displaying as Warehoused in the Audit screen. For more information on warehouse states, read ‘About the Audit grid’ in About the Audit screen.