Overview and examples of the Picturepark DAM API
Basic and Extended API
The Picturepark Web Service API is split between read and write operations. The read operation methods are freely available as a part of every Picturepark instance. This enables developers to become familiar with Picturepark and its API without the expense of a write license.
The complete Picturepark Web Service API (read and write) requires a license on customer side. Picturepark technology partners can integrate on both Web services.
Picturepark Asset Connector (PAC) Framework
The Picturepark Asset Connector framework provides all the Web service methods and UI components required to select and retrieve Picturepark-managed digital assets from another application. It provides you with a mini Picturepark UI that can appear from within external applications. Users can search, select and place assets into other applications with minimal development effort on your part.
The framework is frequently used for integrations into CMS, PIM or ERP systems that enable users to pull images or video from Picturepark for use on a web page or in a publication.
Picturepark Subscription Service
Picturepark includes a subscription service that is available to users via the UI and available to developers via the API. The service monitors the system and sends notifications when assets have been added, deleted or modified, depending on the configuration of the specific notification.
For greater control over the events that trigger notifications, search queries can be applied to subscriptions. For example, a user might want to know about asset changes only when she’s the person responsible for the asset.
Subscriptions also permit Picturepark to notify external software applications via the product’s Web Services API. So, for example, if a CMS needs a fresh copy of an updated image, Picturepark can send that alert any time an image has been updated. This enables you to provide updates to assets and metadata that has been used in external systems.
Web Service API Examples
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:
Login with credentials:
Note: Don’t forget to Close the session at the end of the program
Search for an asset
Download an asset
- CreateSession (see “Create a connection to Picturepark,” above)
- GetAssets (see “Search for an asset,” above)
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.]