The Remote API allows you to edit a text of your graphics package. To do so, follow steps below:
1. Generate your graphics token
Learn how to generate your token here.
2. Generate an API identifier
From the graphics editor you can generate an API identifier for your text element, just complete step 1 and 2 from the image below.
(1) Select a text element from your graphics tree.
(2) On the inspector, click the Show on Remote Control icon to enable the Control API ID field and add an identifier for this text element.
3. Getting the Integration ID
To add a Custom ID to an overlay:
(1) Select the overlay.
(2) In the inspector on the right side, click # No ID, and add the ID.
Example Request for Windows
Use the following curl to edit your text and send your graphics IN (On Air)
curl --request PATCH "https://api.flowics.com/graphics/TOKEN-GRAPHICS/control/overlays" --header "Content-Type: application/json" --data-raw "[{\"id\": \"OVERLAY-ID\",\"state\": \"in\",\"controls\": {\"CONTROL-API-ID\": {\"value\": \"YOUR-TEXT\"}}}]"
Use the following curl to edit your text when your graphics is already IN (On Air)
curl --request PATCH "https://api.flowics.com/graphics/TOKEN-GRAPHICS/control/overlays" --header "Content-Type: application/json" --data-raw "[{\"id\": \"OVERLAY-ID\","controls\": {\"CONTROL-API-ID\": {\"value\": \"YOUR-TEXT\"}}}]"KEY | DESCRIPTION | TYPE |
TOKEN-GRAPHICS | It is the identifier of your graphic package. | String |
OVERLAY ID | It is the identifier of the overlay. | String |
CONTROL-API-ID | It is the identifier that you have chosen for each text element. | String |
YOUR-TEXT | The content you want to add to each text element. | String |