Access OpenAPI documentation
API documentation is available locally on a Prep in the form of the OpenAPI documentation. This tool is useful for easily testing API calls against the server and viewing the responses.
Use the OpenAPI documentation to explore the ML Prep REST API's more advanced features, and interact with the API directly from the browser.
To ensure best network compatibility when establishing REST API connection, locate and use the IP address of the Prep connected to the PC. To accomplish this:
Turn on the Prep.
Locate and access Settings.
Locate the Instrument tab.
Select Configuration.
Wait for information to load, then locate and select the Network Settings tab.
Locate the IP address of the Internal PC, then perform a quick test.
Launch a web browser on a PC connected to the same network as the Prep.
Go to http://<IP>/NimbusLite/api-docs/index.html to navigate to API documentation.
The Swagger application should launch.
Locate the OpenAPI documentation for the Prep REST API.