Wie können wir dir helfen ?

Wie richte ich die API ein und erstelle API-Keys?

ℹ️
Verfügbar ab dem Tarif Team. Dieser Artikel richtet sich an Administratoren.
📄
Kurzfassung: Über die REST-API steuerst du pixx.io programmatisch an – für individuelle Anbindungen an andere Systeme wie PIM oder ERP. Der Zugriff erfolgt über einen API-Key.

Voraussetzung

Nur Nutzer mit Admin-Rechten können einen API-Key erstellen.

API-Key erstellen

  1. Gehe zu "Einstellungen → Verwaltung → API" auf den Tab "API-Key".
  1. Klicke auf "Neuen Key erstellen".
  1. Vergib einen Namen und weise dem Key einen Nutzer zu. Der Key erbt anschließend genau die Rechte dieses Nutzers – alle darüber ausgeführten Aktionen (z. B. Uploads oder Downloads) werden so behandelt, als kämen sie direkt von diesem Nutzer.
  1. Optional schränkst du die Nutzung unter "Anwendungseinschränkung" auf eine bestimmte IP-Adresse ein.
  1. Klicke auf "Key erstellen".
ℹ️
Beachte: Teile deinen API-Key aus Sicherheitsgründen niemals mit anderen Personen – er gewährt vollen Zugriff im Rahmen der Rechte des zugewiesenen Nutzers.

Wie authentifiziere ich API-Anfragen?

pixx.io nutzt HTTP Bearer Authentication. Den API-Key sendest du bei jeder Anfrage im Authorization-Header:

Authorization: Bearer {dein_api_key}

Beispiel:

curl --location \
'{deine_mediaspace_url}/api/v1/collections?page=1&pageSize=20' \
--header 'Authorization: Bearer {dein_api_key}'
ℹ️
Beachte: Ein häufiger Fehler ist eine falsche Basis-URL. Richtig ist {deine_mediaspace_url}/api/v1/... – nicht {deine_mediaspace_url}/media/api/v1/....

Rate-Limits

Die Rate-Limits gelten pro System und damit gemeinsam für alle API-Keys eines Mediaspace:

  • Bis zu 167 Requests innerhalb von 10 Sekunden
  • Bis zu 50.000 Requests pro Tag

Vertraglich können abweichende Limits vereinbart sein.

Wichtige technische Hinweise

  • OriginalFileURL und PreviewFileURL sind veraltet: Nutze stattdessen die CDN-Link-Endpunkte.
  • Pagination: Die cursor-basierte Pagination ist der aktuelle Standard für das Abrufen von Dateilisten.
  • UND/ODER-Verknüpfung: Die Weboberfläche verknüpft Filterkriterien immer mit UND. Über den Files-Get-Endpunkt lässt sich dagegen ein individueller Filter mit AND- und OR-Konnektoren bauen, auch mehrstufig.
  • Bulk-Upload und Duplikate: Beim Hochladen mehrerer Dateien liefert die API auch bei einem erkannten Duplikat success: true zurück, obwohl kein echter Upload stattgefunden hat. Ob es sich um ein Duplikat handelt, erkennst du nur an den speziellen Response-Feldern der Antwort.
  • Varianten-Verknüpfung: Das Verknüpfen von Varianten lässt sich derzeit nicht über die API automatisieren, da kein passender Endpunkt existiert.
  • Keine Sandbox-Umgebung: Für Tests steht keine separate Testumgebung zur Verfügung; Tests laufen direkt gegen den produktiven Mediaspace.

Wo sehe ich meine API-Keys?

Die Tabelle unter "Einstellungen → Verwaltung → API" zeigt zu jedem Key: Name, API-Key, Requests (täglich), Erstellungsdatum, zugewiesener Benutzer und Status.

💡
Praxistipp: Die vollständige technische Dokumentation aller Endpunkte findest du unter api.pixxio.com/docs. Für Automatisierungen ohne eigene Entwicklung ist oft die Kombination aus API und Webhooks der einfachere Weg – siehe die Artikel Wie nutze ich Webhooks in pixx.io? und "pixx.io mit Make.com verbinden und automatisieren".

Verwandte Artikel

Hat dies deine Frage beantwortet?
😞
😐
🤩