Reveal is a data visualization solution provided by Infragistics and can be paired with the CData API Server to build dynamic dashboards from live Vimeo data. The CData API Server generates an OData API for Vimeo, which is natively consumable in Reveal. In this article, we walk through connecting to Vimeo in API Server and connecting to the API Server from Infragistics Reveal to create a simple dashboard.
Connect to Vimeo from API Server
CData API Server uses a straightforward, point-and-click interface to connect to data sources and generate APIs.
- Open API Server and click Settings -> Connection -> Add Connection
π Adding a connection
- Select "Vimeo"
π Selecting a Connector (Salesforce is shown).
- Enter the necessary authentication properties to connect to Vimeo.
Vimeo is a professional video hosting platform. The Vimeo API uses personal access tokens (bearer tokens) to enable secure access to video metadata, user information, channels, groups, categories, and related resources.
Using API Key Authentication
To authenticate to the Vimeo API, you will need to provide a personal access token. To obtain your access token:
- Log in to your Vimeo account at https://vimeo.com
- Navigate to https://developer.vimeo.com/apps
- Create a new app or select an existing app
- Under "Personal Access Tokens", click "Generate" to create a new token
- Select the required scopes: public and private for read access
- Copy the generated token
After obtaining your access token, set the following connection properties:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your Vimeo personal access token.
Example connection string
Profile=C:\profiles\Vimeo.apip;ProfileSettings='APIKey=your_personal_access_token';
π Configuring a connection (Salesforce is shown).
Add Vimeo Resource Definitions in API Server
After connecting to Vimeo, create Resources, which represent API endpoints for Vimeo data.
- Click Settings -> Resources -> Add Resource
π Adding a new resource
- Select the Vimeo connection
π Selecting a connection (Salesforce is shown)
- Select the table you wish to retrieve and click Next
π Selecting a Table (Salesforce is shown)
- (Optional) Edit the resource to select specific fields and more
- Save the settings
Add an API Server User
Create a User to connect to Vimeo from Reveal through API Server.
- Click Settings -> Users
- Click Add
- Configure a User with access to the Vimeo Connection and Resource(s)
π Creating a new user
π API Server users
(Optional) Configure Cross-Origin Resource Sharing (CORS)
When accessing and connecting to multiple different domains from an application such as Ajax, there is a possibility of violating the limitations of cross-site scripting. In that case, configure the CORS settings in Settings -> Server.
- Enable cross-origin resource sharing (CORS): ON
- Allow all domains without '*': ON
- Access-Control-Allow-Methods: GET, PUT, POST, OPTIONS
- Access-Control-Allow-Headers: Authorization
Save the changes to the settings.
π Configuring CORS settings
Create a Dashboard in Reveal
With the API Server configured, we can visualize Vimeo data in Reveal.
- Log into Reveal and click Dashboards -> New
π Adding a new dashboard
- Click Data Source -> OData Feed
π Adding a new OData data source
- Specify the API Server API endpoint URL, for example: https://serverurl/api.rsc
π Configuring the OData URL
- Select Generic Credentials and specify the API Server username and authentication token
π Configuring the credentials
- Select the entity you wish to visualize
π Selecting an entity to visualize (Salesforce is shown.)
- Select fields and choose a chart type
π Visualizing data in Reveal (Salesforce is shown.)
More Information & Free Trial
At this point, you have created a simple dashboard from live Vimeo data. For more information on creating OData feeds from Vimeo (and more than 150 other sources), visit the API Server page. Download a free, 30-day trial and start working live Vimeo data in tools that consume OData APIs.