Plugin SDK | pixx.io

01 Prinzip

Wie funktioniert das Plugin SDK?

Das Plugin SDK wird als Iframe in deine Anwendung eingebunden. Der pixx.io-Nutzer meldet sich innerhalb dieses Iframes an und wählt Bilder oder Videos aus seinem Mediaspace aus. Sobald die Auswahl bestätigt ist, schickt das SDK eine Liste der gewählten Dateien — inklusive Download-Link und ein paar Metadaten — per postMessage an deine Anwendung.

Den eigentlichen Download der Dateien übernimmt danach deine Anwendung selbst. Da das SDK diesen Download nicht sieht, erwartet es von dir laufend Fortschritts-Updates — auch die schickst du per postMessage zurück.

Alle Nachrichten folgen demselben Schema: { sender: 'pixxio-plugin-sdk', method: string, parameters?: unknown[] } bzw. mit receiver statt sender in die andere Richtung.

02 Integration

Zwei Wege der Einbindung

Volle Kontrolle

Direkt per Iframe + postMessage

Du bindest den Iframe selbst ein und implementierst das Nachrichtenprotokoll direkt. Funktioniert mit jedem Frontend-Stack, unabhängig von Framework oder Sprache.

Schnellster Einstieg

`@pixx.io/jsdk`

Offizielles JavaScript-Paket, das Iframe-Einbindung und Nachrichten-Handling für dich übernimmt. Verfügbar über npm.

javascript

npm install @pixx.io/jsdk
import '@pixx.io/jsdk/build/pixxio.jsdk.css';
import PIXXIO from '@pixx.io/jsdk';
const picker = new PIXXIO({
  appKey: 'DEIN_APP_KEY',
  appUrl: 'https://dein-mediaspace.pixxio.media',
  modal: true,
  element: document.getElementById('picker-target'),
  language: 'de'
});
// picker öffnet sich als Modal oder eingebettet in "element",
// je nach appUrl kann der Login-Schritt übersprungen werden,
// wenn du appUrl + refreshToken bereits kennst

03 Konfiguration

Konfiguration per Query-Parameter

Wenn du direkt per Iframe-URL arbeitest, lässt sich das SDK über Query-Parameter steuern:

Parameter	Beschreibung
standaloneLogin=true	Login-Seite leitet nicht automatisch weiter, sondern meldet den Login-Erfolg per `postMessage`
dark=true	Schaltet das Plugin SDK in den Dark Mode
allowedFileTypes	Filtert die Medienansicht nach Dateiendungen, z. B. `?allowedFileTypes=jpg&allowedFileTypes=png`

Beispiel: https://plugin.pixx.io/static/v2/de/media?allowedFileTypes=jpg&allowedFileTypes=png&allowedFileTypes=tiff

Das SDK ist auf Deutsch und Englisch verfügbar — steuerbar über den Sprachpfad (/de/ bzw. /en/).

04 Zusammenspiel

In Kombination mit API & Webhooks

🧩

Das Plugin SDK übernimmt nur die Auswahl von Dateien innerhalb deiner Anwendung. Für serverseitige Automatisierung — etwa automatisches Nachladen von Metadaten oder Reagieren auf spätere Änderungen — kombinierst du es mit der REST-API und optional mit Webhooks.

Bereit, einen Picker einzubauen?

Die vollständige Dokumentation inklusive Nachrichtenprotokoll und aller Parameter findest du direkt beim SDK.

Zur Plugin-SDK-Dokumentation → API Webhooks Automatisierung