APIs Overview
In Designer version r21, we introduced the ability to perform a number of controls from an API.
In Designer version r23.2, we released new APIs. With the release, we launched a new documentation portal specifically detailing our new suite of APIs.
Since the first release of our APIs, we have added new ones and updated existing ones. You can find the Designer APIs, RenderStream SDK, and SMC API documented on the Developer Portal.
What is an API?
An API (Application Programming Interface) is a set of rules and protocols that allows one software application to interact with another. It defines the methods and data formats that programmes can use to request and exchange information. Essentially, an API serves as a bridge that allows different software systems to communicate with each other.
Disguise’s APIs are used to make calls to Designer from an external, virtual, or actual physical interface to d3 projects to trigger a change or event. To make the call command, users must provide references to specific existing d3 projects and items within those. This is done by referencing the Unique Identifier (UID) for the object you want to interact with.
Opening API Documentation
Designer uses an OpenAPI format (Swagger Docs) for the d3 API.
To access the API, open d3Manager, click Help, and select Open API Documentation.
Configuring API
By default the API uses TCP port 80. This can be can be changed in d3Manager.
- Open d3Manager.
- Select Machine Settings > Advanced Network Configuration.
- Change the port specified under API http port.
To disable the API entirely, so no ports are open. Set the port to 0.
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 Designer has a numeric UID assigned to it.
For additional information on APIs, please visit https://developer.disguise.one