A simple Vimeo integration for fetching meta data and previewing videos in Inriver

Summary

This is a simple integration between Inriver PIM and Vimeo. The main purpose of this integration is to fetch metadata about the video from Vimeo and to make it possible for PIM editors to preview their Vimeo videos directly in PIM.

This integration consists of two parts:

Part one: An Entity Listener that listens to entities of type Resource that are created or updated with a value in the field “ResourceVimeoId”. The extension then fetches metadata and a screencap from Vimeo (using Vimeos API).

Part two: An HTML template (Enrich template) that makes it possible to preview the Video from Vimeo straight on the Resource entity in Enrich.

Supported features

Fetch metadata and screen cap from Vimeo.

Preview video directly in PIM

Disclaimer

This is an inspirational extension/integration, it is not a supported component of inriver or Cypoint Inspire. The source code is provided as-is with no warranty, you are free to modify the application and to make improvements.

Using the feature

Link to source code on Github: https://github.com/danieljanssoncypoint/PIM.Vimeo.Integration

To get this integration up and running you first need to have an account at https://vimeo.com and then register an app at https://developer.vimeo.com/

When everything is set up you need to generate an access token for your Vimeo app. That token will be used both by the Entity Listener and in the HTML template.

Now you need to add a new Field Type to the Resource Entity Type. The Field Type ID used in code is “ResourceVimeoId” (Data type String). If you want to rename it, you need to update the Entity Listener and the HTML template.

Download the source code from the Github link above, build and upload the extension (feel free to make any adjustments that suits your PIM system. Here is a link on how to upload and manage extensions: https://community.inriver.com/hc/en-us/articles/360012413554

Set up an extension of Extension type: Entity Listener. The configuration should look something like this:

After you have created the extension, you need to add your access token. Press “Get Default Settings” or add a setting manually with Key: “VIMEO_ACCESS_TOKEN”.

You can now test the Entity Listener by creating a new Resource Entity from Enrich app, all you need to add is the Vimeo Video Id. It could look something like this:

If everything has worked as it should then your Resource should look like this when you open it:

Now its time to set up the HTML Template. Update them HTML code with your access token and create a new HTML Template of type “Edit template”:

Note that Data Mode needs to be “Full” and Entity Types should only be Resource.

Now you can test if the "Preview Video template" is working on your Resource:

Enjoy your Vimeo integration :) Please let me know if you have any issues or questions.

Regards,

Daniel

Join the Easter Challenge!

join the community conversations

A simple Vimeo integration for fetching meta data and previewing videos in Inriver

Summary

Supported features

Disclaimer

Using the feature

Comments