Skip to content
BranchesTags

Repository files navigation

Getting Started with Vimeo API

Introduction

Build something great. Vimeo's API supports flexible, high-quality video integration with your custom apps.

Building

Requirements

The SDK relies on Node.js and npm (to resolve dependencies). It also requires Typescript version >=4.1. You can download and install Node.js and npm from the official Node.js website.

NOTE: npm is installed by default when Node.js is installed.

Verify Successful Installation

Run the following commands in the command prompt or shell of your choice to check if Node.js and npm are successfully installed:

  • Node.js: node --version

  • npm: npm --version

Version Check

Install Dependencies

  • To resolve all dependencies, go to the SDK root directory and run the following command with npm:
npm install
  • This will install all dependencies in the node_modules folder.

Resolve Dependencies

Installation

The following section explains how to use the generated library in a new project.

1. Initialize the Node Project

  • Open an IDE/text editor for JavaScript like Visual Studio Code. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

  • Click on File and select Open Folder. Select an empty folder of your project, the folder will become visible in the sidebar on the left.

Open Folder

  • To initialize the Node project, click on Terminal and select New Terminal. Execute the following command in the terminal:
npm init --y

Initialize the Node Project

2. Add Dependencies to the Client Library

  • The created project manages its dependencies using its package.json file. In order to add a dependency on the Vimeo APILib client library, double click on the package.json file in the bar on the left and add the dependency to the package in it.

Add VimeoApilib Dependency

  • To install the package in the project, run the following command in the terminal:
npm install

Install VimeoApilib Dependency

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
timeout number Timeout for API calls.
Default: 30000
httpClientOptions Partial<HttpClientOptions> Stable configurable http client options.
unstableHttpClientOptions any Unstable configurable http client options.
logging PartialLoggingOptions Logging Configuration to enable logging
bearerCredentials BearerCredentials The credential object for bearer
oauth2AuthorizationCodeCredentials Oauth2AuthorizationCodeCredentials The credential object for oauth2AuthorizationCode
oauth2ClientCredentialsCredentials Oauth2ClientCredentialsCredentials The credential object for oauth2ClientCredentials

The API client can be initialized as follows:

Code-Based Client Initialization

import {
  Client,
  LogLevel,
  OauthScopeOauth2AuthorizationCode,
  OauthScopeOauth2ClientCredentials,
} from 'vimeo-apilib';

const client = new Client({
  bearerCredentials: {
    accessToken: 'AccessToken'
  },
  oauth2AuthorizationCodeCredentials: {
    oauthClientId: 'OAuthClientId',
    oauthClientSecret: 'OAuthClientSecret',
    oauthRedirectUri: 'OAuthRedirectUri',
    oauthScopes: [
      OauthScopeOauth2AuthorizationCode.Ai,
      OauthScopeOauth2AuthorizationCode.Create
    ]
  },
  oauth2ClientCredentialsCredentials: {
    oauthClientId: 'OAuthClientId',
    oauthClientSecret: 'OAuthClientSecret',
    oauthScopes: [
      OauthScopeOauth2ClientCredentials.Ai,
      OauthScopeOauth2ClientCredentials.Create
    ]
  },
  timeout: 30000,
  logging: {
    logLevel: LogLevel.Info,
    logRequest: {
      logBody: true
    },
    logResponse: {
      logHeaders: true
    }
  },
});

Configuration-Based Client Initialization

import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'vimeo-apilib';

// Provide absolute path for the configuration file
const absolutePath = path.resolve('./config.json');

// Read the configuration file content
const fileContent = fs.readFileSync(absolutePath, 'utf-8');

// Initialize client from JSON configuration content
const client = Client.fromJsonConfig(fileContent);

See the Configuration-Based Client Initialization section for details.

Environment-Based Client Initialization

import * as dotenv from 'dotenv';
import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'vimeo-apilib';

// Optional - Provide absolute path for the .env file
const absolutePath = path.resolve('./.env');

if (fs.existsSync(absolutePath)) {
  // Load environment variables from .env file
  dotenv.config({ path: absolutePath, override: true });
}

// Initialize client using environment variables
const client = Client.fromEnvironment(process.env);

See the Environment-Based Client Initialization section for details.

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

About

typescript SDK for Vimeo API

Resources

Readme
License
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages