It covers how to locate the MediaFlow control API and where to find related documentation.
Before using the API, note that all BRICKS APIs use GraphQL format for communication. You will need a basic understanding of GraphQL syntax before proceeding.
🕐 Estimated time to complete this tutorial: 1–2 minutes
Step 1: Open the MediaBox Edit Page in BRICKS Controller
Click the [Media] tab, select any MediaBox, and then click [Edit].
Step 2: Locate the GraphQL API Link in New Passcode Section
In the New Passcode section, click the [?] icon.
In the expanded description, find the [GraphQL API] link.
Step 3: Check the API Documentation and Schema
On the API page, click [Doc] on the right panel to view supported API operations.
Click [Schema] to review the data structure.
Step 4: Start Communicating with MediaFlow API
You are now ready to communicate with MediaFlow via its API.
Refer to the [Doc] section for details on supported API methods.
Refer to the [Schema] section for details on the data structure.
The next tutorial will explain how to query the BANK API.
If you need any help, click the chat icon in the bottom-right corner and we’ll get back to you as soon as possible.