[JIMLN] ToolsOnAir REST API v.6.1
With the introduction of the ToolsOnAir REST API, a new path of integration has opened up, allowing you to seamlessly incorporate just:in mac lite NDI into your tailored workflows. This new advancement empowers you to initiate recordings remotely, directly from external systems. By utilising REST API calls, you gain the flexibility to integrate just:in mac lite NDI into your existing infrastructure with ease.
This new ToolsOnAir REST API provides almost all the features of the well-known Just Control user interface. The ToolsOnAir REST API can easily be tested with the Postman.app for macOS or with the integrated Swagger-UI.
Swagger-UI
To access the integrated Swagger-UI, open a web browser and enter the following address: "IP-Address:8080/swagger-ui/index.html". You should then see the following:
Here the API can be easily tested. If you want to use Postman for testing, please follow the instructions below.
Import into Postman by using a URL
If you use the Postman.app on the same machine as the Just In Mac Lite NDI application, you can use this link - http://localhost:8080/v3/api-docs - to import the ToolsOnAir REST API into the Postman.app. Simply open the Postman.app and use the “Import File” Option.
Then use the link - http://localhost:8080/v3/api-docs - and paste it into the “URL” field.
The Postman.app automatically detects the ToolsOnAir REST API and by pressing the “Import” button the process can be completed.
Afterward, the ToolsOnAir REST API can be tested with the Postman.app. Please note that the IP address might need to be adjusted.
Use http://editor.swagger.io
In case the Postman.app is not an option, http://editor.swagger.io can be used alternatively. Analogous to the Postman App open the link - http://localhost:8080/v3/api-docs - on the machine where the Just In Mac Lite NDI application is running and copy the contents of that page. Then open http://editor.swagger.io in a browser of your choice and paste the API JSON content to the left side of this page. The ToolsOnAir REST API will appear on the right side of this page.