Vimeo App Installation Guide

Vimeo is a video-sharing platform that lets you upload, share, and view high-quality videos. It focuses on providing a creative community for filmmakers, artists, and professionals to showcase their work. Vimeo offers various tools and features to help creators manage and distribute content while maintaining a visually appealing and ad-free environment.

Contentstack Marketplace lets you install the Vimeo application and use it within your stack to fetch and display videos from the Vimeo account within your entries.

• Vimeo account
• Contentstack account
• Access to the Contentstack Organization/Stack as the Owner/Admin

Let's follow this step-by-step guide to install and configure the Vimeo app within your stack.

1. Retrieve the Access Token from the Vimeo Account
2. Install and Configure the Vimeo app in Contentstack Marketplace
3. Use the Vimeo app within your Stack Entry

1. Retrieve the Access Token from the Vimeo Account

   link

   To get the access token for Vimeo, follow the steps given below:

   1. Log in to the Vimeo account using your Vimeo account credentials.

      NoteTo add videos to your Vimeo account, click the Upload button. Then, on the next screen, you can drag-and-drop the videos, or click the Choose files button, select the videos, and add them to your account.

   2. Now, go to Vimeo’s developer page and click the + Create an app button at the top right corner.
      
      Click to enlarge
   3. Enter the App name and a Brief description of your app. Please note that these are mandatory fields. Then, choose who can access your app, accept the terms and conditions, and click Create App.
      Click to enlarge
      
      The app gets created successfully.
   4. Now, open your newly created app. Click the Authentication tab in the left navigation panel and select Generate Access Token.
      To get the access token, select the Authenticated (you) option. Under the Scopes section, select Private and click the Generate button.
      
      Click to enlarge
      
      The access token is now generated. Copy the Vimeo Access Token to your clipboard to use in Step 2.
      
      Click to enlarge

      Additional ResourceTo learn more about access tokens in Vimeo, refer to the Generate an access token documentation.

2. Install and Configure the Vimeo app in Contentstack Marketplace

   link

   Follow the steps given below to install the application in Contentstack.

   1. Log in to your Contentstack account.
   2. In the left-hand side primary navigation, click the Marketplace icon to go to the Marketplace.
      
      Click to enlarge
   3. Click Apps from the left panel.
   4. Within the Marketplace, you can see all the available apps. Hover over the Vimeo app and click Install.
      
      Click to enlarge
   5. In the pop-up window, select the stack where you want to install the Vimeo app, accept the terms and conditions, and click the Install button.
      Click to enlarge
   6. On the Configuration screen, enter the following details:
      1. Vimeo Access Token: Enter the Vimeo Access Token retrieved from your Vimeo Account in Step 1.
      2. Folder Settings: Folder settings allows you to fetch videos directly from specific folders. To enable the Folder settings option, click the toggle button. You will see the Get Folders button. Click on it to fetch all folders and then select them in the dropdown.

         NoteEnabling the Folder settings will not impact the videos already stored in the entry.

      3. Choose the Vimeo Keys to Save in Entry: Choose how to save the data fetched from the Vimeo account in Contentstack entries.
         1. If you select the All Fields option, you can select only a limited number of videos in the entry.
         2. For Custom Fields, you can search and add specific Vimeo Keys you want to save in entries.

         WarningWhen you change the settings from All Fields to Custom Fields, and vice versa, any existing assets will follow the old configuration settings, whereas newly added assets in the entry will store the data according to the updated configuration settings. This is applicable on Custom and JSON RTE fields.

         Click to enlarge
         
         If you select Custom Fields then the Vimeo Keys dropdown appears. By default, uri, name, link, pictures.base_link, and description options are already selected inside the dropdown. If you want to create a new key, click the + New Key Field option.
         
         Click to enlarge

         In the Add Key Path modal, enter the Vimeo Key Path and click the Create or Create and Apply button to create a new key.

         Click to enlarge

   7. On the UI Locations tab, you can see the predefined app locations. You can use the toggle button corresponding to each UI location to enable or disable it based on your requirements.
      Click to enlarge
   8. Click the Save button.
   9. If the webhook is enabled for your app, you can view the webhook logs under the Webhook tab.

      Additional ResourceFor more information on UI location and webhooks, please refer to the Installed Apps guide.

   10. Click Open Stack to start using the Vimeo application.

3. Use the Vimeo app within your Stack Entry

   link
   NoteBefore using the Vimeo application, you will need the following browser settings:

   • Pop-ups should be enabled.
   • Third-party cookies should be enabled.

   To use the Vimeo application within an entry of your stack, follow the steps given below:

   1. Go to your stack, click the Content Models icon in the left navigation panel, and click the + New Content Type button.
   2. Create a content type by adding relevant details as displayed below:
      Click to enlarge

   There are two ways to use the Vimeo application in your entry:

   1. Custom Field
   2. JSON Rich Text Editor Field

   Steps to use the Vimeo application using a Custom field

   link
   1. In the Content Type Builder page, add a Custom field in your content type by clicking the Insert a field link represented by a + sign.
   2. Under Select Extension/App, select Vimeo, and click the Proceed button.
      
      Click to enlarge
      
      Change the Display Name of the custom field to your choice, for example, Vimeo Custom Field. Optionally, you can add Help Text and Instruction Value for your custom field. This adds the Vimeo app in the custom field.
      
      Click to enlarge
   3. After adding the app in a custom field, click Save or Save and Close to save your changes.
   4. To use the Vimeo app, create an entry for this newly created content type. To do this, in the left navigation panel, navigate to the Entries page, click + New Entry to create a new entry for the above content type, and then click Proceed.
      You can see the Vimeo app’s custom field on your entry page as shown below:
      
      Click to enlarge
   5. Click the + Choose Video(s) button.
      
      Click to enlarge
   6. Select the video(s) from your Vimeo selector page and click the Add Videos(s) button to add them to your entry.
      
      Click to enlarge

      NoteYou can add multiple videos in one go.

      You can filter videos based on folders. By default, the folders configured at the time of installation in Step 2 are selected.
      Click to enlarge

      You can search for videos on the Vimeo selector page.

      Click to enlarge
      
      Also, you can view the videos in a Comfortable or Compact view. By default, the Comfortable view is selected.
      Hover over the video on the Vimeo selector page. You will see the Open in Vimeo option to view the video directly in the Vimeo platform.
      
      Click to enlarge
      
      The videos you insert get referenced within your entry in the thumbnail view, by default.
      
      Click to enlarge
      
      To change the default view, select List from the drop-down menu as shown in the following screenshot:
      
      Click to enlarge
      
      The videos you insert get referenced within your entry in the list view.
      Click to enlarge
   7. Hover over the video to access these features:
      1. Click the Reorder icon to drag and reorder the video.
      2. Click the Open in Vimeo icon to open the video on the Vimeo platform.
      3. Click the Remove icon to remove the video.

      Thumbnail View

      Click to enlarge

      List View

      Click to enlarge
   8. After adding the video(s), Save and Publish your entry.

   Steps to use the Vimeo application using a JSON Rich Text Editor field:

   link
   1. In the Content Type Builder page, add a JSON Rich Text Editor field in your content type by clicking the Insert a field link represented by a + sign.
   2. Under Select JSON RTE Plugin(s), select Vimeo, and then click Add Plugin(s).
      
      Click to enlarge
      
      This adds Vimeo in the JSON Rich Text Editor field.
      
      Click to enlarge
   3. After adding the app in a JSON Rich Text Editor field, click Save or Save and Close to save your changes.
   4. To use the Vimeo app as a JSON RTE plugin, create an entry for this content type. You will see the Vimeo app icon inside the JSON RTE field in your entry page as shown below:
      
      Click to enlarge
   5. Click the Vimeo app icon.
      
      Click to enlarge
   6. Select the video(s) from your Vimeo selector page and click the Add Videos(s) button to add them to your entry.
      
      Click to enlarge

      NoteYou can add multiple videos in one go.

      You can filter videos based on folders. By default, the folders configured at the time of installation in Step 2 are selected.
      
      Click to enlarge
      
      You can search for videos on the Vimeo selector page.
      Click to enlarge

      Also, you can view the videos in a Comfortable or Compact view. By default, the Comfortable view is selected.
      Hover over the video on the Vimeo selector page, and you can see the Open in Vimeo option to go directly to the Vimeo platform.
      

      Click to enlarge
      The videos you selected get referenced within your entry:
      
      Click to enlarge
      
      
   7. To resize the video, drag the corner and adjust the size as required. Hover over the video to access these features:
      1. Click the Open in Vimeo icon to preview the video on the Vimeo platform.
      2. Click the Edit icon to edit the video.
      3. Click the Remove icon to remove the video.
      Click to enlarge

      Additional ResourceYou can use alignment and inline asset features to edit the video placement within the JSON Rich Text Editor field.

   8. After adding the video(s), Save and Publish your entry.