Vår standardlösning för API-integrationer förenklar ditt arbete när du integrerar Mediaflow med en CMS-plattform eller andra system där syftet är att ladda ner filer och/eller bädda in videoklipp från Mediaflow. Här hittar du information om hur du arbetar med vårt API och en integrationsguide för Mediaflows File Selector.
Arbetsflöde för användaren
En API-integration mot Mediaflow inkluderar ett arbetsflöde där användaren kan välja att ladda ner filer som kopieras till systemets eget lagringsutrymme. Alternativt kan användaren välja att bädda in videoklipp på en sida. När filer används i er integration, kommer användning redovisas genom att automatiskt spara information i Mediaflow, vilket gör det enkelt att spåra var filer används.
Integrationskit för nedladdning av bilder och inbäddning av video
Vill du bygga en standardlösning där användarna ska komma åt filer för att publicera dem, rekommenderar vi att du använder vårt integrationskit. Det förenklar arbetet eftersom det består av en File Selector där användaren kan bläddra i mappar, söka efter filer (med eller utan vårt AI-stöd för sökord), se viktig metadata för filer, välja filer och beskära bilder. Alternativt kan man även bädda in videofiler.
Exempel på Mediaflows File Sector:
Tillgång till filer från Mediaflow i ditt system
För att kunna styra vilka mappar som ska vara synliga för användarna i ert system, skapas en användargrupp i Mediaflow för denna typ av integration. Detta är ett standardförfarande för att kunna hantera tillgång till mappar och filer för användargrupper i Mediaflow, i en integrationer eller i en Mediaportaler.
Standardiserad konfiguration i Mediaflow
Nedladdningsformat
I Mediaflow kan administratörer välja vilka nedladdningsformat användare i ett CMS eller annat system ska ha tillgång till. Detta gör det enkelt för användarna att beskära bilder i lämpliga format (till exempel webbformat för CMS som jpg och png).
GDPR-restriktioner
Mediaflows File Selector kommer som standard automatiskt att dölja filer som ni inte har hanterat korrekt enligt GDPR. (Notera att administratörer i Mediaflow kan göra globala inställningar för om restriktioner i GDPR-modulen ska ignoreras för alla integrationer.)
Redovisa användning automatiskt
När en fil monteras med en integration, rekommenderar vi att du använder Mediaflows funktion för att redovisa användning. Detta innebär att när en fil monteras skickar integrationen tillbaka information till Mediaflow om var filen används som en URL, inklusive namn och datum (även information när filen har avpublicerats).
Ladda upp filer till Mediaflow från integrationen (valfritt)
I Mediaflow kan du som inloggad användare enkelt ladda upp filer i olika mappar. Ni kan även tillåta uppladdning via en så kallad webblänk. Ibland kan det dock vara nödvändigt att bygga en funktion för uppladdning till Mediaflow direkt från integrationen. Vi rekommenderar att detta byggs genom att skapa ett gränssnitt där användaren väljer en mapp att ladda upp till. Detta kan göras genom API-anrop som listar vilka mappar man kan ladda upp till. Om ni väljer att tillåta uppladdning mot bara en standardmapp, behöver ni ange mapp-ID:t i konfigurationen. Vi rekommenderar att ni då även tillåter uppladdning till en så kallad fallback-mapp ifall uppladdningsmappen skulle raderas av en användare.
Gräns för uppladdning
Notera att det finns en gräns på 2 GB för uppladdning av filer.
Checklista - Funktioner att implementera i ditt system
Möjlighet att lägga till API-/integrationsnycklar i inställningar
Lägg till en inställningssida för integrationen så att användare/administratörer kan spara nycklar och ställa in vissa globala inställningar för integrationen. De fält som behövs är ClientID, ClientSecret och ServerKey.
Lägg till funktionen för att redovisa användning
När din plattform skickar tillbaka information till Mediaflow om hur en fil har används, behöver det inkludera en URL till sidan, ett användarnamn och ett datum. Vi rekommenderar att detta ska göras även när en bild har avpublicerats så att man kan se i Mediaflow att bilden inte längre är publik. För att detta ska vara möjligt behöver usage-id, som följer med när användning skickades in första gången, användas i anropet.
AI sök
Du kan se om ni har AI-sökning aktiverad genom att kontrollera om ai_assisted_search_default finns i svaret från /users/me?fields=activeModules. Därefter kan du aktivera det i sökningen genom att lägga till /users/me?fields=activeModules i POST-anropet för sökningen.
Alt-texter
I Mediaflow finns ett dedikerat fält för alt-texter. Du kan välja att konfigurera hur detta fält används i integrationen, om fältet ska hämtas automatiskt från Mediaflow och om det ska vara obligatoriskt. Det är också möjligt att implementera detta som en global inställning. Med Mediaflows ai-funktion för alt-texter får du med ett knapptryck förslag på alt-text för bilder. Du väljer själv vilket språk du vill ha alt-texten på.
Möjlighet att ladda upp filer (valfritt)
Ni kan lägga till möjlighet för användare att ladda upp filer och bygga ett gränssnitt för att välja en mapp att ladda upp till. Om du väljer att implementera möjligheten för administratörer att ställa in en standardmapp för uppladdning i Mediaflow, behöver administratörer ställa in mapp-ID. Mapp-ID:t är synligt när en mapp väljs.
Spara nedladdade filer i ditt system
Du kan göra en global inställning för var importerade bilder sparas (beroende på hur ditt system fungerar). Till exempel kan alla importerade filer sparas automatiskt i en mapp som ni kallar "Bilder från Mediaflow". Eller så sparas bilder på sidan där bilden är publicerad. Du kan också bestämma om användaren själv ska kunna välja detta.
Olika sätt att infoga bilder eller video
Beroende på system finns det ett antal sätt att infoga bilder och video som vi rekommenderar:
Anpassad datatyp
Många system har någon form av datatyper som kan konfigureras för att bygga upp en sida eller ett block. Du kan bygga en datatyp som antingen kan infoga både video och bilder eller dela upp dem i två olika block.
Infoga-knapp för WYSIWYG
Det är också vanligt att implementera en anpassad Mediaflow-knapp i systemets WYSIWYG-redigerare för att kunna infoga bilder och videor direkt i brödtexten på en sida.
Spara infogade filer i systemets egna filväljare
Om ditt CMS eller annat system stödjer detta kan det vara bra att även ha ett sätt att infoga bilder genom systemets egna filväljare. Detta gör det enklare för era användare. Är detta inte möjligt kommer man för befintliga bilder förmodligen inte kunna välja nya bilder från Mediaflow utan att byta till nya filväljaren.
Möjlighet att känna av storlek på bildblock
Vissa system stöder bildblock med fasta dimensioner. Ni kan välja att skicka denna information till Mediaflows File Selector så att den vet vilken storlek en bild ska beskäras till. På detta sätt behöver ni inte använda nedladdningsformat i Mediaflow. Istället justeras bildens storlek dynamiskt när du väljer att montera en bild i ett bildblock.
Inställningar för att bädda in video
Video bör bäddas in med Javascript eller iframe. Du kan lägga till en global inställning för detta eller låta användaren välja
Tillåtna bild- och videoformat
Det är viktigt att ni gör globala standardinställningar för vilka filtyper (både bilder och videor) som ska visas i Mediaflows File Selector. t ex .jpg .png m.m. Vissa kunder kan dock ha specifika behov. Det kan vara bra att låta era administratörer ställa in ytterligare tillåtna filformat i ert system. Observera att det även går att tillåta format som ert system inte stöder, till exempel .tif-filer, eftersom originalfilerna kommer att konverteras till en av de tillåtna nedladdningsformat som administratörer har tillåtit i Mediaflow.
NOTERA: PDF-filer stöds ej.
Teknisk information
Teknisk guide för integrationer
Integrations-kit för Mediaflows File Selector (JavaScript-baserad)
Här hittar du mer information.
Fullständig API-dokumentation
Detta behövs oftast för en standardintegration men ni kan behöva lägga till andra funktioner med hjälp av API endpoint.