This topic introduces the concepts of APIs and UIDs within Disguise software.
What is an API?
An API is defined as an application programming interface. Within Disguise software, it is accessible via d3Manager and allows direct access to specific software functionality within the software.
Designer's API documentation can be found by opening SwaggerDocs directly from d3Manager. This can be launched on the localhost of a local machine, or via a remote machine.
The APIs shown in SwaggerDocs are expressions of call commands that can be made from an external, virtual or actual physical interface to d3 projects to trigger a change or event. To make the call command, users need to provide references to specific existing d3 projects, and to items within those. This is done by referencing UIDs.
Opening API Documentation
Disguise software uses an OpenAPI format for d3 API.
To access the API, open d3Manager, and from the Help menu, select Open API Documentation.
What is a UID?
A unique identifier (UID) is a numeric or alphanumeric string that is associated with a single entity within a given system. Every item in Disguise softwarehas a numeric UID assigned to it.
Please note: For additional information on APIs, please visit https://developer.disguise.one
