Picturepark API und Framework Überblick

Auf dieser Seite finden Sie alle Informationen, welche Möglichkeiten Sie als Picturepark Entwickler haben.

Basic und Extended API

Die Picturepark Web Services API besteht aus zwei Teilen. Mit der kostenlosen Basic API haben Sie Lesezugriff auf das Picturepark System. Dies ermöglicht es Entwicklern Erfahrungen mit der Picturepark API zu sammeln und Integration zu erstellen, für die es nicht notwendig ist Daten in Picturepark zu schreiben. Mit der Extended API haben Sie Lese – und Schreibzugriff, was Ihnen viele Möglichkeiten einer Integration eröffnet. Die Verwendung der Extended API benötigt eine Lizenz, die der Kunde erwerben muss. Picturepark Technologie Partner können beide Web Services verwenden.

Picturepark Asset Connector (PAC) Framework

Das Picturepark Asset Connector Framework bietet einen einfachen Zugriff auf Assets aus einer externen Applikation. Das Framework stellt UI Komponenten zur Verfügung, sodass Benutzer innerhalb der ihm bekannten Picturepark UI nach Assets suchen können. Nachdem der Benutzer ein Asset ausgewählt hat, kann dieses über die Integration, die das Framework aufgerufen hat heruntergeladen werden.

Das Picturepark Asset Connector Framework eignet sich besonders gut für Integrationen zu CMS, PIM oder ERP System, also überall da, wo Assets aus Picturepark in ein anderes System importiert oder verlinkt werden sollen.

Picturepark Benachrichtigungs-Service

Picturepark enthält einen Benachrichtigungs-Service. Dieser ist sowohl für Benutzer in Picturepark, als auch für Entwickler über die API verfügbar. Der Service ermöglicht es Assets zu überwachen und Benachrichtigungen zu senden, wenn Assets hinzugefügt, verändert oder gelöscht werden, je nachdem wie die Benachrichtigung konfiguriert ist.

Für größere Kontrolle darüber, wann Sie benachrichtigt werden, können Sie Abonnements auch mit Suchanfragen verbinden. Diese Abfragen definieren die Umstände, welche die Benachrichtigung auslösen. So wollen Sie beispielsweise nur dann informiert werden, wenn Änderungen in Bezug auf Assets vorgenommen wurden, für die Sie verantwortlich sind.

Dank der Abonnements kann Picturepark über sein Web Service-API auch externe Applikationen informieren. Wenn etwa Ihr CMS immer wieder eine Kopie eines aktualisierten Bildes braucht, kann Picturepark immer dann eine Meldung an das CMS übergeben, wenn das Bild aktualisiert wurde.

Web Service API Beispiele

[toggle  title=“Create a connection to Picturepark“]

There are two possibilities for login: with credentials or with security token.

If you want to login with security token, do the following:

  1. GetSecurityToken
  2. LoginWithSecurityToken

Login with credentials:

Note: Don’t forget to Close the session at the end of the program

[/learn_more]

Search for an asset

At the GetAsset method it is possible to attach a Filter (ExtendedAssetFilter)

Download an asset

  1. CreateSession (see „Create a connection to Picturepark,“ above)
  2. GetAssets (see „Search for an asset,“ above)
  3. Download

You can download one or multiple assets in a single call. Important is the ArrayOfAssetSelection parameter. This list of AssetSelection contains the AssetId and the DerivativeDefinitionId.

Note: Picturepark can handle different derivatives of an asset. You need to know which derivative you want download. For this, please first check for all possible derivatives for the asset. At the AssetItem object is an AvailableDerivativeDefinitions array. In this array are all derivative IDs for which the connected user has permission to download. More information about the derivatives of an asset are store also in the AssetItem. Please see the Array Derivatives with its object Derivative.

Retrieve metadata of an asset

Once you have the AssetItem, you can also get its metadata. You can find them at the FieldValue array. The KnownFieldValue contains the ID and the value. To know which field is behind this ID, use GetAssetFields to query for all metadata fields in the system. There you will find an array of the object Field that contains all the information you need.

View all Picturepark API Methods »