The Mercury API is based on the Swagger 2.0 standard. Swagger is a powerful open source framework backed by a large ecosystem of tools that helps you design, build, document, and consume RESTful APIs.

The specification creates the RESTful contract for an API, detailing all of its resources and operations in a human and machine-readable format for easy development, discovery, and integration.

The Swagger specification defines a set of files required to describe such an API. These files can then be used by the Swagger-UI project to display the API and Swagger-Codegen to generate clients in various languages. Additional utilities can also take advantage of the resulting files, such as testing tools.

The files describing the RESTful API in accordance with the Swagger specification are represented as JSON objects and conform to the JSON standards. YAML, being a superset of JSON, can be used as well to represent a Swagger specification file.

The Mercury API specification has been represented in the YAML format.

Not all Person and Opportunity fields currently have endpoints. If you want a new field made available, request this via the Ideas Portal. When updates are made these requests will all be taken into consideration.

ideas.connective.com.au

The swagger specification for the Mercury API can be downloaded from here:

Swagger updated 3 September 2021

APPLICATIONS THAT OPEN A .YML FILE -Apple TextEdit, Notepad2, Microsoft Notepad, Microsoft Wordpad