{"id":32490,"date":"2023-03-08T16:33:24","date_gmt":"2023-03-08T15:33:24","guid":{"rendered":"https:\/\/mimolive.com\/?post_type=user-manual&#038;p=32490"},"modified":"2024-10-08T11:01:10","modified_gmt":"2024-10-08T09:01:10","slug":"voorbeelden-van-api-gebruik","status":"publish","type":"user-manual","link":"https:\/\/mimolive.com\/nl\/user-manual\/remote-control-automation\/http-api\/examples-of-api-usage\/","title":{"rendered":"Voorbeelden van API-gebruik"},"content":{"rendered":"<h2 class=\"wp-block-heading\">Vereisten<\/h2>\n\n\n\n<p>- Open het document dat u wilt bewerken in mimoLive.<br>- Zorg ervoor dat het document in een voltooide staat is, zodat de API-eindpunten zoals Lagen niet meer veranderen. Houd er rekening mee dat als je een laag verwijdert en weer toevoegt, deze laag een andere laag-ID krijgt als je er via de API mee praat. Het opnieuw ordenen van lagen of het toevoegen van laagvarianten zal de laag-ID echter niet veranderen.<br>- Schakel de <span class=\"caps\">HTTP<\/span>-server in de voorkeuren voor afstandsbediening van mimoLive. Vink de optie \"Toegang op afstand toestaan\" aan:<\/p>\n\n\n\n<figure class=\"wp-block-image size-full is-resized\"><img fetchpriority=\"high\" decoding=\"async\" width=\"1000\" height=\"542\" src=\"https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/9e0a2b0b-6a64-4093-b15b-24aa12dead32.png\" alt=\"\" class=\"wp-image-32491\" style=\"width:570px;height:auto\" srcset=\"https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/9e0a2b0b-6a64-4093-b15b-24aa12dead32.png 1000w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/9e0a2b0b-6a64-4093-b15b-24aa12dead32-300x163.png 300w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/9e0a2b0b-6a64-4093-b15b-24aa12dead32-768x416.png 768w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/9e0a2b0b-6a64-4093-b15b-24aa12dead32-18x10.png 18w\" sizes=\"(max-width: 1000px) 100vw, 1000px\" \/><\/figure>\n\n\n\n<p>Noteer het IP-nummer of IP-adres met het poortnummer van mimoLive voor verder gebruik bij het werken met de <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span>.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Manieren om mimoLive op afstand te bedienen<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\">Bediening van mimoLive met afstandsbedieningsoppervlakken<\/h3>\n\n\n\n<p>De meest effectieve manier is om een aangepaste <a href=\"https:\/\/mimolive.com\/nl\/gebruikershandleiding\/mimolive-gebruiken\/oppervlakken-voor-afstandsbediening\/\" data-type=\"user-manual\" data-id=\"31791\">Afstandsbedieningsoppervlak<\/a> voor uw mimoLive-document, dat op een iPad, iPhone of elk ander apparaat met een internetbrowser kan draaien.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">MimoLive besturen met php<\/h3>\n\n\n\n<p>We hebben een goed gedocumenteerd voorbeeld PHP script op GitHub: <br><a href=\"https:\/\/github.com\/boinx\/mimoLive-HTTP-Demo\" target=\"_blank\" rel=\"noreferrer noopener\">https:\/\/github.com\/boinx\/mimoLive-<span class=\"caps\">HTTP<\/span>-Demo<\/a><\/p>\n\n\n\n<h3 class=\"wp-block-heading\">MimoLive besturen met <span class=\"caps\">CURL<\/span><\/h3>\n\n\n\n<p>Om mimoLive te bedienen via <span class=\"caps\">HTTP<\/span> kun je het bash commando \"curl\" gebruiken. Om de curl-commando's te laten werken, moet je de ID vinden van het mimoLive-document dat je wilt manipuleren.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">MimoLive besturen met Automatiseringslaag<\/h3>\n\n\n\n<p>De <a href=\"https:\/\/mimolive.com\/nl\/gebruikershandleiding\/automatisering\/\">Automatiseringslaag<\/a> kunnen enkele eenvoudige commando's uitvoeren om acties in mimLive te activeren door hun <span class=\"caps\">API<\/span> Eindpunten. Het heeft ook een httpRequest() commando om elk soort <span class=\"caps\">GET<\/span> verzoekacties de <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span> in staat is.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">MimoLive besturen met Apple Script<\/h3>\n\n\n\n<p>Momenteel ondersteunt mimoLive geen Apple Script. Je kunt echter een workaround gebruiken om mimoLive te bereiken: Er is een \"do shell script\" commando in apple script waarmee je bash commando's zoals \"curl\" kunt uitvoeren. De vorige sectie legt uit hoe je een curl commando maakt om een bepaalde laag of laagwaarde te manipuleren.<\/p>\n\n\n<section class=\"boinx_exclamation\">\n    <div class=\"main_div_exclamation\">\n        <div class=\"left_div_icon_exclamation\">\n                <i class=\"icon_exclamation\">\u2757<\/i>\n        <\/div>\n\n        <div class=\"right_div_text_exclamation\">\n                <div><p class=\"text_exclamation_headline\">Valkuilen in Apple Script<\/p><\/div>\n                <div><p class=\"text_exclamation\">In Apple Script zijn er twee valkuilen bij het overbrengen van een terminalopdracht zoals \"curl\" naar de opdracht do shell script: 1. Alle \" moeten voorafgegaan worden door een  om de Apple-Script parser te laten weten dat dit niet de eindmarkeringen zijn voor het do shell script commando. De  is een escape-teken om de parser te vertellen het volgende teken te negeren. 2. Als u meerdere tekstdelen aan elkaar rijgt met &amp;, dan is dit voor Apple Script een \"lijst met tekst\" in plaats van een enkele tekst. Het do shell commando werkt niet met een \"lijst met tekst\" en daarom moet u het terug converteren naar een enkele tekst met de \"as text\" aan het einde van uw curl commando tekst.<\/p><\/div>\n        <\/div>    \n    <\/div>\n<\/section>\n\n\t\t<style>.boinx_exclamation {\n    margin:30px 0;\n    padding:10px;\n    background-color:rgb(242,222,222);\n    border-radius: 8px;\n}\n.icon_exclamation {\n    display:block;\n    padding:5px;\n    font-size:80px;\n    color:rgb(184,74,72);\n    line-height:60px;\n}\n.text_exclamation {\n    color:rgb(184,74,72);\n}\n\n.text_exclamation_headline{\n    font-weight:bold;\n    color:rgb(184,74,72);\n}\n\n\n.main_div_exclamation\n{\n    display:flex !IMPORTANT;\n    flex-wrap: wrap;\n    flex-direction: row;\n    justify-content : flex-start;\n    align-items : flex-start\n    align-content : flex-start;\n    \n}\n\n.left_div_icon_exclamation{\n    display:flex !IMPORTANT;\n    width:80px;\n    padding:10px;\n    margin:20px 20px 20px 0;\n    height:40px;\n}\n.right_div_text_exclamation{\n    display:flex !IMPORTANT;\n    flex-direction: column;\n    flex-grow: 1;\n    width:200px;\n    padding:10px;\n    margin:0;\n}<\/style>\n\t\t\n\n\n<p>Als je tevreden bent met je curl commando moet je het in een \"do shell script\" commando verpakken in Apple Script:<\/p>\n\n\n<section class=\"boinx_section\">\n    <div class=\"main_div\">\n        <div class=\"left_div_icon\">\n                <i class=\"icon_highlight\">*<\/i>\n        <\/div>\n\n        <div class=\"right_div_text\">\n                <div><p class=\"text_highlight_headline\">Zorg ervoor dat u xxxxxxxxx vervangt door uw specifieke laag API Eindpunt!<\/p><\/div>\n                <div><p class=\"text_highlight\"><\/p><\/div>\n        <\/div>    \n    <\/div>\n<\/section>\n\n\t\t<style>.boinx_section {\n    margin:30px 0;\n    padding:10px;\n    background-color:rgb(217,237,248);\n    border-radius: 8px;\n  \n}\n\n.icon_highlight {\n    display:block;\n    padding:5px;\n    font-size:80px;\n    color:rgb(58,134,172);\n    line-height:60px;\n}\n\n.text_highlight {\n    color:rgb(58,134,172);\n}\n\n.text_highlight_headline{\n    font-weight:bold;\n    color:rgb(58,134,172);\n}\n\n.main_div\n{\n    display:flex !IMPORTANT;\n    flex-wrap: wrap;\n    flex-direction: row;\n    justify-content : flex-start;\n    align-items : flex-start\n    align-content : flex-start;\n}\n.left_div_icon{\n    display:flex !IMPORTANT;\n    width:40px;\n    padding:0;\n    margin:10px 20px 10px 10px;\n    \n}\n.right_div_text{\n    display:flex !IMPORTANT;\n    flex-direction: column;\n    flex-grow: 1;\n    padding:10px;\n    margin:0;\n    width:200px;\n    }<\/style>\n\t\t\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>set layerAPIEndpoint to \"xxxxxxxxx\" -- in our example this would be \"http:\/\/172.28.30.202:8989\/api\/v1\/documents\/458706932\/layers\/BA868701-8131-49CB-8EDD-8C7E6E7CD60B\"\n\nset lowerThirdTitle to \"Hello World!\"\ndo shell script \"curl -d '{\\\"input-values\\\":{\\\"tvGroup_Content__Title\\\":\\\"\" &amp;amp; lowerThirdTitle &amp;amp; \"\\\"}}' -H \\\"Content-Type: application\/json\\\" -X PUT \\\"\" &amp;amp; layerAPIEndpoint &amp;amp; \"\\\"\" as text\n\n<\/code><\/pre>\n\n\n\n<p>Het volgende voorbeeldscript van Apple laat zien hoe je elk half uur op het hele uur een laag kunt inschakelen: Dit kan handig zijn voor commerci\u00eble overlays. Zorg ervoor dat je een laag gebruikt die zichzelf na een bepaalde tijd uitschakelt (bijvoorbeeld een plaatslaag met een niet-lopende filmbron doet dat).<\/p>\n\n\n<section class=\"boinx_section\">\n    <div class=\"main_div\">\n        <div class=\"left_div_icon\">\n                <i class=\"icon_highlight\">*<\/i>\n        <\/div>\n\n        <div class=\"right_div_text\">\n                <div><p class=\"text_highlight_headline\">Zorg ervoor dat u xxxxxxxxx vervangt door uw specifieke laag API Eindpunt!<\/p><\/div>\n                <div><p class=\"text_highlight\"><\/p><\/div>\n        <\/div>    \n    <\/div>\n<\/section>\n\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>-- configure your Layer API Endpoint:\nset layerAPIEndpoint to \"xxxxxxxxx\" -- in our example this would be \"http:\/\/172.28.30.202:8989\/api\/v1\/documents\/458706932\/layers\/BA868701-8131-49CB-8EDD-8C7E6E7CD60B\"\n-- repeat endlessly:\nrepeat\n\t-- get the seconds last in this hour\n\tset currentDate to current date\n\tset secondsToNextHour to 3600 - ((minutes of currentDate) * 60 + (seconds of currentDate))\n\t-- --------------------------------------------\n\t-- The following code snippet is useful only if you want to\n\t-- switch the layer live on half hours also.\n\t-- if you don't want this behaviour you can delete this part.\n\t-- --------------------------------------------\n\t-- check if we are currently in the first half of the hour\n\tif secondsToNextHour &amp;gt; 1800 then\n\t\t-- yes, we are in the first half of the hour, so only wait half the time\n\t\tset secondsToNextHour to secondsToNextHour - 1800\n\tend if\n\t-- --------------------------------------------\n\t-- wait until the time to trigger the layer\n\tdelay secondsToNextHour\n\t-- set the specified layer to live:\n\tdo shell script \"curl \\\"\" &amp;amp; layerAPIEndpoint &amp;amp; \"\/setLive\\\"\" as text\n\t-- wait a couple of seconds to make sure we don't glitch in time\n\tdelay 5\nend repeat\n\n<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\">Gebruikersinterface-elementen in mimoLive besturen<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\">Een <span class=\"caps\">API<\/span> Eindpunt<\/h3>\n\n\n\n<p><\/p>\n\n\n\n<p>API endpoints zijn essentieel voor het adresseren van specifieke elementen in uw mimoLive document. Voor een lijst van beschikbare API-eindpunten, zie <a href=\"https:\/\/mimolive.com\/nl\/gebruikershandleiding\/maatwerk\/http-api\/eindpunten\/\" data-type=\"user-manual\" data-id=\"32488\">API Eindpunten<\/a>.<br><br>V\u00f3\u00f3r mimoLive 5.5 was het moeilijk om het document-ID en bijvoorbeeld een laag-ID te krijgen met Terminal-opdrachten die door lange <span class=\"caps\">JSON<\/span> gegevens. Sinds mimoLive 5.5 is het veel eenvoudiger:<\/p>\n\n\n\n<p>Kopieer eerst de mimoLive <span class=\"caps\">HTTP<\/span> serverbasis <span class=\"caps\">URL<\/span> in de sectie Afstandsbediening van het voorkeurenvenster van mimoLive (zie bovenstaande schermafbeelding). Open een teksteditor (bijv. TextEdit van Apple) en plak de inhoud van het klembord in een nieuw aangemaakt tekstdocument. Zorg ervoor dat er <strong>geen<\/strong> backslash aan het einde van de <span class=\"caps\">URL<\/span>! Het resultaat zou er zo uit moeten zien:<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>http:&#47;&#47;172.28.30.202:8989<\/code><\/pre>\n\n\n\n<p>In het mimoLive-documentvenster kun je met de rechtermuisknop (of control-klik, of twee-vinger-klik) op het object van interesse klikken (bijv. een Layer, een Bron, een knop van een Layer-besturingselement) om een contextmenu te krijgen. Er is een menu-item waarmee je de <span class=\"caps\">API<\/span> Eindpunt naar het macOS Klembord voor gebruik in je mimoLive <span class=\"caps\">API<\/span> project.<\/p>\n\n\n\n<figure class=\"wp-block-image size-full is-resized\"><img decoding=\"async\" width=\"1000\" height=\"740\" src=\"https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/bc6c7e19-e991-48a0-a9b8-b56d690f19b4.png\" alt=\"\" class=\"wp-image-32492\" style=\"width:501px;height:auto\" srcset=\"https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/bc6c7e19-e991-48a0-a9b8-b56d690f19b4.png 1000w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/bc6c7e19-e991-48a0-a9b8-b56d690f19b4-300x222.png 300w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/bc6c7e19-e991-48a0-a9b8-b56d690f19b4-768x568.png 768w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/bc6c7e19-e991-48a0-a9b8-b56d690f19b4-16x12.png 16w\" sizes=\"(max-width: 1000px) 100vw, 1000px\" \/><\/figure>\n\n\n\n<p>Soms is het belangrijk om een specifieke laagvariant aan te pakken in plaats van de laag in het algemeen. Als je met de rechtermuisknop klikt op de parameter van een laag, zie je dat er verschillende <span class=\"caps\">API<\/span> eindpunten voor de huidige live laag of de specifieke laagvariant:<\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img decoding=\"async\" width=\"1000\" height=\"356\" src=\"https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/6120370f-a575-43db-891b-ef3a91d5aec5.png\" alt=\"\" class=\"wp-image-32493\" srcset=\"https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/6120370f-a575-43db-891b-ef3a91d5aec5.png 1000w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/6120370f-a575-43db-891b-ef3a91d5aec5-300x107.png 300w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/6120370f-a575-43db-891b-ef3a91d5aec5-768x273.png 768w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/6120370f-a575-43db-891b-ef3a91d5aec5-18x6.png 18w\" sizes=\"(max-width: 1000px) 100vw, 1000px\" \/><\/figure>\n\n\n\n<p>Ga terug naar je tekstverwerker en plak het zojuist gekopieerde <span class=\"caps\">API<\/span> Eindpunt na de <span class=\"caps\">HTTP<\/span> Serverbasis <span class=\"caps\">URL<\/span>. Nu de <span class=\"caps\">URL<\/span> in je tekstbrowser er zo uit zou moeten zien:<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>http:&#47;&#47;172.28.30.202:8989\/api\/v1\/documents\/458706932\/layers\/BA868701-8131-49CB-8EDD-8C7E6E7CD60B<\/code><\/pre>\n\n\n\n<p>Dit is de laatste <span class=\"caps\">API<\/span> Endpoint om een laag in je document aan te spreken. In dit voorbeeld <strong>458706932<\/strong> is de document-ID en <strong>BA868701-8131-49CB-8EDD-8C7E6E7CD60B<\/strong> is de specifieke laag-ID van een bepaalde laag in dit document.<\/p>\n\n\n\n<p>Rechtsklikken op bepaalde gebruikersinterface-elementen om een contextmenu weer te geven voor het verkrijgen van het specifieke API-eindpunt werkt voor het volgende:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Bronnen<\/li>\n\n\n\n<li>Lagen<\/li>\n\n\n\n<li>Laagvarianten<\/li>\n\n\n\n<li>Laag Parameter<\/li>\n\n\n\n<li>Uitvoer Bestemmingen<\/li>\n\n\n\n<li>Laag sets<\/li>\n<\/ul>\n\n\n\n<figure class=\"wp-block-image size-large is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"266\" src=\"https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/Screenshot-2024-10-08-at-10.19.00-1024x266.png\" alt=\"\" class=\"wp-image-39712\" style=\"width:575px;height:auto\" srcset=\"https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/Screenshot-2024-10-08-at-10.19.00-1024x266.png 1024w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/Screenshot-2024-10-08-at-10.19.00-300x78.png 300w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/Screenshot-2024-10-08-at-10.19.00-768x199.png 768w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/Screenshot-2024-10-08-at-10.19.00-18x5.png 18w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/Screenshot-2024-10-08-at-10.19.00.png 1132w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">Voorbeeld: AAN en UIT schakelen <span class=\"caps\">UIT<\/span> a Laag<\/h3>\n\n\n\n<p>Met de opgehaalde <span class=\"caps\">API<\/span> Eindpunt voor een bepaalde laag kun je aan- en uitzetten met de volgende terminalopdrachten.<\/p>\n\n\n<section class=\"boinx_section\">\n    <div class=\"main_div\">\n        <div class=\"left_div_icon\">\n                <i class=\"icon_highlight\">*<\/i>\n        <\/div>\n\n        <div class=\"right_div_text\">\n                <div><p class=\"text_highlight_headline\"><\/p><\/div>\n                <div><p class=\"text_highlight\">Zorg ervoor dat u xxxxxxxxx vervangt door het API Endpoint uit de vorige stap!<\/p><\/div>\n        <\/div>    \n    <\/div>\n<\/section>\n\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>curl xxxxxxxxx\/setLive\ncurl xxxxxxxxx\/setOff\ncurl xxxxxxxxx\/toggleLive\n# our example will look like this:\ncurl http:\/\/172.28.30.202:8989\/api\/v1\/documents\/458706932\/layers\/BA868701-8131-49CB-8EDD-8C7E6E7CD60B\/setLive<\/code><\/pre>\n\n\n<section class=\"boinx_section\">\n    <div class=\"main_div\">\n        <div class=\"left_div_icon\">\n                <i class=\"icon_highlight\">*<\/i>\n        <\/div>\n\n        <div class=\"right_div_text\">\n                <div><p class=\"text_highlight_headline\">De URL's werken ook in een internetbrowser<\/p><\/div>\n                <div><p class=\"text_highlight\">Deze URL's (zonder het \"curl\" commando) kunnen ook in de adresbalk van een internetbrowser geplaatst worden. Zodra je op return drukt zal de browser de mimoLive HTTP server aanroepen en de opdracht uitvoeren die je hebt opgegeven. Als je JSON data hebt die je naar het API endpoint moet sturen kun je dit ook toevoegen aan de URL, zie \"Converteren van een CURL commando met JSON data naar een HTTP URL voor eenvoudige HTTP verzoeken\" hieronder.<\/p><\/div>\n        <\/div>    \n    <\/div>\n<\/section>\n\n\n\n\n<p>Een eenvoudige manier om de volledige HTTP URL te verkrijgen om de live-status van een laag in of uit te schakelen, is door met de rechtermuisknop op de Live-knop van de laag te klikken om een contextmenu te openen en 'Copy URL To Set Layer Live' (URL kopi\u00ebren om laag live in te stellen) te selecteren. Hiermee wordt de URL naar het klembord gekopieerd voor gebruik. In de schermafbeelding ziet u het contextmenu voor de Live-knop van een Lower Third laag.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"249\" src=\"https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/Screenshot-2024-10-08-at-10.13.16-1024x249.png\" alt=\"\" class=\"wp-image-39711\" style=\"width:643px;height:auto\" srcset=\"https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/Screenshot-2024-10-08-at-10.13.16-1024x249.png 1024w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/Screenshot-2024-10-08-at-10.13.16-300x73.png 300w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/Screenshot-2024-10-08-at-10.13.16-768x187.png 768w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/Screenshot-2024-10-08-at-10.13.16-18x4.png 18w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/Screenshot-2024-10-08-at-10.13.16.png 1174w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">Voorbeeld: Een waarde van een laag wijzigen<\/h3>\n\n\n\n<p>- Alle parameters van een laag kunnen worden ingesteld via de <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span>. Je moet de juiste sleutel vinden om een nieuwe waarde in te stellen. In ons voorbeeld stellen we de titel van een <a href=\"https:\/\/mimolive.com\/nl\/gebruikershandleiding\/onderste-derde\/\">Lower Third Laag<\/a> met de sleutel tvGroup_Content__Title. Omdat we de nieuwe waarde in een <span class=\"caps\">JSON<\/span> bestand naar de <span class=\"caps\">HTTP<\/span> server met een <span class=\"caps\">PUT<\/span> het curl commando aanvragen wordt een beetje druk.<\/p>\n\n\n\n<p><i>*<\/i>Zorg ervoor dat u xxxxxxxxx vervangt door uw specifieke laag <span class=\"caps\">API<\/span> Eindpunt!<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>curl -d '{\"input-values\":{\"tvGroup_Content__Title\":\"My new title\"}}' -H \"Content-Type: application\/json\" -X PUT \"xxxxxxxxx\"\n<\/code><\/pre>\n\n\n\n<p>Een snelle manier om een volledige HTTP URL te verkrijgen om de update van een laageigenschap te triggeren, is door met de rechtermuisknop op de naam van de eigenschap te klikken, waardoor een contextmenu verschijnt, en \"Copy URL To Change '.....'\" te selecteren. \"Deze menuopdracht kopieert een HTTP URL naar het klembord, die bij het oproepen (bijv. in een internetbrowser) de eigenschap op de huidige waarde instelt. Door de URL te bekijken, kunt u bepalen welk deel ervan gewijzigd moet worden om uw eigen gegevens naar deze eigenschap te sturen. In de schermafbeelding ziet u het contextmenu voor het kopi\u00ebren van de URL om de ondertitel van een Lower Third laag te wijzigen.<\/p>\n\n\n\n<figure class=\"wp-block-image size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"752\" height=\"334\" src=\"https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/Screenshot-2024-10-08-at-10.05.39.png\" alt=\"\" class=\"wp-image-39708\" style=\"width:349px;height:auto\" srcset=\"https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/Screenshot-2024-10-08-at-10.05.39.png 752w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/Screenshot-2024-10-08-at-10.05.39-300x133.png 300w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/Screenshot-2024-10-08-at-10.05.39-18x8.png 18w\" sizes=\"(max-width: 752px) 100vw, 752px\" \/><\/figure>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>http:\/\/127.0.0.1:8989\/api\/v1\/documents\/xxxxxxxxxxxx\/layers\/yyyyyyyyyyyy\/variants\/zzzzzzzzzzzz?include=data.attributes.input-values&amp;fields&#91;input-values]=tvGroup_Content__Subtitle&amp;update=%7B%22input-values%22:%7B%22tvGroup_Content__Subtitle%22:%22<strong>mimoLive%20User<\/strong>%22%7D%7D<\/code><\/pre>\n\n\n<section class=\"boinx_exclamation\">\n    <div class=\"main_div_exclamation\">\n        <div class=\"left_div_icon_exclamation\">\n                <i class=\"icon_exclamation\">\u2757<\/i>\n        <\/div>\n\n        <div class=\"right_div_text_exclamation\">\n                <div><p class=\"text_exclamation_headline\">De nieuwe waarde in de URL moet URL-gecodeerd zijn!<\/p><\/div>\n                <div><p class=\"text_exclamation\">In dit voorbeeld wordt de spatie tussen \"mimoLive\" en \"User\" gecodeerd als<\/p><\/div>\n        <\/div>    \n    <\/div>\n<\/section>\n\n\n\n\n<h2 class=\"wp-block-heading\">Beste Praktijken<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\">Verzameling van nuttige <span class=\"caps\">API<\/span> Commando's om te verkennen<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\">De <span class=\"caps\">RTMP<\/span> <span class=\"caps\">URL<\/span> en Streaming Key van een Live Streaming uitvoerbestemming:<\/h4>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>curl --data '{\"data\": { \"attributes\": {\"settings\": {\"rtmpurl\":\"rtmp:\/\/mystreaminghost.com\", \"streamingkey\":\"<strong>MYTOTALLYSECRETSTREAMKEY<\/strong>\"} } } }' --request PATCH http:\/\/192.168.0.100:8989\/api\/v1\/documents\/xxxxxxxxx\/output-destinations\/yyyyyyyyyyyyy<\/code><\/pre>\n\n\n\n<h4 class=\"wp-block-heading\">De bestandsnaam en het pad van een uitvoerbestemming van de bestandsschrijver instellen<\/h4>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>curl --data '{\"data\": { \"attributes\": {\"settings\": { \"location\": \"<strong>~\/Destktop\/Recordings<\/strong>\", \"filename\": \"<strong>MyGreatShow %year-%month-%day-%hour-%minute.%extension<\/strong>\" } } } }' --request PATCH http:\/\/192.168.0.100:8989\/api\/v1\/documents\/xxxxxxxxxxxx\/output-destinations\/yyyyyyyyyyyy<\/code><\/pre>\n\n\n\n<h4 class=\"wp-block-heading\">De videobron van een plaatsingslaag instellen<\/h4>\n\n\n\n<p>yyyyyyyyyyy zal de <span class=\"caps\">UUID<\/span> van de videobron. (e.g CCAF4418-367A-415F-AD25-6536C3EF3512)<\/p>\n\n\n\n<p>xxxxxxxxxxxxxxxxxxxxx zal de <span class=\"caps\">API<\/span> eindpunt van de bepaalde laagvariant. (e.g. http:\/\/172.28.30.202:8989\/api\/v1\/documents\/2014814935\/layers\/BA868701-8131-49CB-8EDD-8C7E6E7CD60B\/variants\/AA868701-8131-49CB-8EDD-8C7E6E7CD60A)<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>curl -d '{\"input-values\":{\"tvIn_VideoSourceAImage\":\"yyyyyyyyyyyyy\"}}' -H \"Content-Type: application\/json\" -X PUT \"xxxxxxxxxxxxxxxx\"<\/code><\/pre>\n\n\n\n<h4 class=\"wp-block-heading\">Het volume instellen van een laag met een audiovolumeknop<\/h4>\n\n\n\n<p>Met dit curl commando kun je het geluidsvolume wijzigen van een laag die een audio-instelknop heeft (zoals de <a href=\"https:\/\/mimolive.com\/nl\/gebruikershandleiding\/placer\/\">Minerale laag<\/a>). De waarde \"volume\" kan waarden aannemen van 0,0 tot 1,0.<\/p>\n\n\n\n<p>xxxxxxxxxxxxxxxxxxxxx zal de <span class=\"caps\">API<\/span> eindpunt van de laag (bijv. http:\/\/10.101.2.2:8989\/api\/v1\/documents\/13195157\/layers\/BA868701-8131-49CB-8EDD-8C7E6E7CD60B)<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>curl -d '{\"volume\": 0.5}' -H \"Content-Type: application\/json\" -X PUT \"xxxxxxxxxxxxxxxx\"<\/code><\/pre>\n\n\n\n<h4 class=\"wp-block-heading\">De kleur van een achtergrondlaag instellen<\/h4>\n\n\n\n<p>xxxxxxxxxxxxxxxxxxxxx zal de <span class=\"caps\">API<\/span> eindpunt van de bepaalde laagvariant. (e.g. http:\/\/172.28.30.202:8989\/api\/v1\/documents\/2014814935\/layers\/BA868701-8131-49CB-8EDD-8C7E6E7CD60B\/variants\/AA868701-8131-49CB-8EDD-8C7E6E7CD60A)<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>curl -d '{\"input-values\":{\"tvGroup_Appearance__Color_1\":{\"red\": 1.0, \"blue\": 0.5, \"green\": 0, \"alpha\": 0.5}}}' -H \"Content-Type: application\/json\" -X PUT \"xxxxxxxxxxxxxxxx\"<\/code><\/pre>\n\n\n\n<h4 class=\"wp-block-heading\">Het bestandspad van een videobron van de laatste opname wissen<\/h4>\n\n\n\n<p>In uw <a href=\"https:\/\/mimolive.com\/nl\/gebruikershandleiding\/bronnen-en-de-bronnen-repository\/\">Bronnenarchief<\/a>kun je een <a href=\"https:\/\/mimolive.com\/nl\/gebruikershandleiding\/laatste-opnamebron\/\">Laatste opnamebron<\/a> die toegang geeft tot de laatste opname die elke Bestand Opname Uitvoer Bestemming zal aankondigen. In een kiosktoepassing zal het nodig zijn om het laatste opnamepad te wissen zodat de volgende gebruiker van het station niet in staat is om de opname van de vorige gebruiker te bekijken. Met het volgende <a href=\"https:\/\/mimolive.com\/nl\/gebruikershandleiding\/automatisering\/\">Opdracht Automatiseringslaag<\/a> kunt u deze informatie wissen uit de Laatste opnamebron:<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>httpRequest(http:\/\/127.0.0.1:8989\/api\/v1\/documents\/2014814935\/sources\/2014814935-413AC0A3-AC43-4A7D-A228-6D0181BF1476?update=%7B%22filepath%22%3A%22%22%7D)<\/code><\/pre>\n\n\n\n<h4 class=\"wp-block-heading\">Opslaan <span class=\"caps\">JSON<\/span> Gegevens in het mimoLive-document<\/h4>\n\n\n\n<p>Met het \"datastores\" eindpunt kun je elk soort data in het mimoLive document opslaan om het te behouden na een documentherlading. Je moet een \"<span class=\"caps\">PUT<\/span>\" verzoek om de gegevens op te slaan en een \"<span class=\"caps\">GET<\/span>\" om het terug te lezen. Je kunt alle soorten gegevens opslaan, maar in dit voorbeeld slaan we op <span class=\"caps\">JSON<\/span> Gegevens omdat dit een veelvoorkomend gebruik lijkt te zijn. Als je andere gegevens wilt opslaan, moet je de -H parameter overeenkomstig aanpassen.<\/p>\n\n\n\n<p>Curl commando om gegevens op te slaan:<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>curl \u2014data '{\"myData1\": 1.5, \"myData2\":\"Some text\"}' -H \"Content-Type: application\/json\" -X PUT http:\/\/127.0.0.1:8989\/api\/v1\/documents\/1643911183\/datastores\/myDataStore1<\/code><\/pre>\n\n\n\n<p>Curl commando om gegevens terug te lezen:<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>curl -X <span class=\"caps\">GET<\/span> http:\/\/127.0.0.1:8989\/api\/v1\/documents\/1643911183\/datastores\/myDataStore1<\/code><\/pre>\n\n\n\n<h4 class=\"wp-block-heading\">Het bronbestandspad van een mediabron bijwerken<\/h4>\n\n\n\n<p>Misschien wil je de film die wordt afgespeeld vervangen of een advertentie die wordt getoond door een <a href=\"https:\/\/mimolive.com\/nl\/gebruikershandleiding\/mediabestand\/\">Bron mediabestand<\/a>. Dit kan worden gedaan met een updateopdracht die wordt uitgevoerd op de bron <span class=\"caps\">API<\/span> eindpunt.<\/p>\n\n\n\n<p>Zorg ervoor dat de bestandsreferentiemodus van de mediabron is ingesteld op \"Absolut Path\". Verkrijg de <span class=\"caps\">API<\/span> eindpunt voor deze bron door er met de rechtermuisknop op te klikken in de linkerkolom en \"Kopieer bron <span class=\"caps\">API<\/span> Endpoint to Clipboard\" in het contextmenu. Maak een <span class=\"caps\">URL<\/span> van de volgende vorm:<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>http:\/\/127.0.0.1:8989\/api\/v1\/documents\/&lt;YOUR DOCUMENT ID&gt;\/sources\/&lt;SOURCE API ENDPOINT&gt;?update={\"filepath\":\"&lt;LOCAL FILE PATH&gt;\"}<\/code><\/pre>\n\n\n\n<p>Zorg ervoor dat je de <span class=\"caps\">JSON<\/span> gegevens in de <span class=\"caps\">URL<\/span> om een geldige <span class=\"caps\">URL<\/span> die als volgt in een curl-opdracht kan worden gebruikt:<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>curl -X GET http:\/\/127.0.0.1:8989\/api\/v1\/documents\/1748069974\/sources\/1748069974-334DA2E4-DFF3-4225-8F4A-D09D40A6BD5D?update=%7B%22filepath%22:%22~\/Desktop\/Screen%20Recording%202022-07-27%20at%2012.18.23.mov%22%7D<\/code><\/pre>\n\n\n\n<p><i>*<\/i>Merk op dat je gebruik kunt maken van de \"~\" aan het begin van het bestandspad om te verwijzen naar de thuismap van de huidige gebruiker.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Een <span class=\"caps\">CURL<\/span> commando met <span class=\"caps\">JSON<\/span> Gegevens naar een <span class=\"caps\">HTTP<\/span> <span class=\"caps\">URL<\/span> voor eenvoudige <span class=\"caps\">HTTP<\/span> Verzoeken<\/h3>\n\n\n\n<p>Soms is het alleen mogelijk om een eenvoudige <span class=\"caps\">HTTP<\/span> verzoek naar mimoLive in plaats van een curl commando, bijvoorbeeld in het geval van 3rd party automation apps of de Automation Layer mimoLive zelf. Hiervoor moet het gegevensblok van het curl-commando worden geconverteerd zodat het deel uitmaakt van de <span class=\"caps\">URL<\/span>. U kunt dit als volgt doen:<\/p>\n\n\n\n<p>Laten we aannemen dat we het volgende curl commando hebben:<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>curl --data '{\"data\": { \"attributes\": {\"settings\": {\"rtmpurl\":\"rtmp:\/\/mystreaminghost.com\", \"streamingkey\":\"MYTOTALLYSECRETSTREAMKEY\"} } } }' --request PATCH http:\/\/192.168.0.100:8989\/api\/v1\/documents\/458706932\/output-destinations\/4D072496-1CE3-418E-B73E-59A2927A2110<\/code><\/pre>\n\n\n\n<p>Je zou de <strong><span class=\"caps\">HTTP<\/span> deel<\/strong> eerst:<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>http:&#47;&#47;192.168.0.100:8989\/api\/v1\/documents\/458706932\/output-destinations\/4D072496-1CE3-418E-B73E-59A2927A2110<\/code><\/pre>\n\n\n\n<p>Voeg  toe <strong>update=<\/strong> aan:<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>http:&#47;&#47;192.168.0.100:8989\/api\/v1\/documents\/458706932\/output-destinations\/4D072496-1CE3-418E-B73E-59A2927A2110?update=<\/code><\/pre>\n\n\n\n<p>Krijg alle <strong>-gegevens string<\/strong> en verwijder alle overbodige spaties:<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>{\"data\":{\"attributes\":{\"settings\":{\"rtmpurl\":\"rtmp:\/\/mystreaminghost.com\",\"streamingkey\":\"MYTOTALLYSECRETSTREAMKEY\"}}}}<\/code><\/pre>\n\n\n\n<p>Codeer dit naar zijn <span class=\"caps\">URL<\/span> vorm door <strong>escapen van de niet-URL-conforme tekens<\/strong> (bijv. met https:\/\/www.urlencoder.org\/)<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>%7B%22data%22%3A%7B%22attributes%22%3A%7B%22settings%22%3A%7B%22rtmpurl%22%3A%22rtmp%3A%2F%2Fmystreaminghost.com%22%2C%22streamingkey%22%3A%22MYTOTALLYSECRETSTREAMKEY%22%7D%7D%7D%7D<\/code><\/pre>\n\n\n\n<p>Zet dit alles ten slotte <strong>na de ?update=<\/strong> op deze manier:<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>http:&#47;&#47;192.168.0.100:8989\/api\/v1\/documents\/458706932\/output-destinations\/4D072496-1CE3-418E-B73E-59A2927A2110?update=%7B%22data%22%3A%7B%22attributes%22%3A%7B%22settings%22%3A%7B%22rtmpurl%22%3A%22rtmp%3A%2F%2Fmystreaminghost.com%22%2C%22streamingkey%22%3A%22MYTOTALLYSECRETSTREAMKEY%22%7D%7D%7D%7D<\/code><\/pre>\n\n\n\n<p>Nu kun je dit gebruiken <span class=\"caps\">URL<\/span> in een eenvoudige <span class=\"caps\">HTTP<\/span> verzoek.<\/p>\n\n\n\n<p><\/p>","protected":false},"excerpt":{"rendered":"<p>Prerequisites &#8211; Open the document you want to manipulate in mimoLive.&#8211; Make sure the document is in a finished state so that the API endpoints like Layers do not change anymore. Please be aware that if you remove a layer and add it again this layer will have a different Layer ID when talking to [&hellip;]<\/p>","protected":false},"author":3,"featured_media":0,"parent":32486,"menu_order":2,"template":"","meta":{"_acf_changed":false,"_angie_page":false,"_lmt_disableupdate":"","_lmt_disable":"","footnotes":""},"categories":[258],"tags":[],"class_list":["post-32490","user-manual","type-user-manual","status-publish","hentry","category-manual"],"acf":[],"_links":{"self":[{"href":"https:\/\/mimolive.com\/nl\/wp-json\/wp\/v2\/user-manual\/32490","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/mimolive.com\/nl\/wp-json\/wp\/v2\/user-manual"}],"about":[{"href":"https:\/\/mimolive.com\/nl\/wp-json\/wp\/v2\/types\/user-manual"}],"author":[{"embeddable":true,"href":"https:\/\/mimolive.com\/nl\/wp-json\/wp\/v2\/users\/3"}],"version-history":[{"count":8,"href":"https:\/\/mimolive.com\/nl\/wp-json\/wp\/v2\/user-manual\/32490\/revisions"}],"predecessor-version":[{"id":39724,"href":"https:\/\/mimolive.com\/nl\/wp-json\/wp\/v2\/user-manual\/32490\/revisions\/39724"}],"up":[{"embeddable":true,"href":"https:\/\/mimolive.com\/nl\/wp-json\/wp\/v2\/user-manual\/32486"}],"wp:attachment":[{"href":"https:\/\/mimolive.com\/nl\/wp-json\/wp\/v2\/media?parent=32490"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/mimolive.com\/nl\/wp-json\/wp\/v2\/categories?post=32490"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/mimolive.com\/nl\/wp-json\/wp\/v2\/tags?post=32490"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}