Getting Started with Vimeo API

Introduction

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

Requirements

The SDK requires Go version 1.18 or above.

Building

Install Dependencies

Resolve all the SDK dependencies, using the go get command.

Installation

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

1. Add SDK as a Dependency to the Application

Add the following lines to your application's go.mod file:

replace vimeoApi => ".\\vimeo-api-go_generic_lib" // local path to the SDK

require vimeoApi v0.0.0

Resolve the dependencies in the updated go.mod file, using the go get command.

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
httpConfiguration	`HttpConfiguration`	Configurable http client options like timeout and retries.
loggerConfiguration	`LoggerConfiguration`	Represents the logger configurations for API calls
bearerCredentials	`BearerCredentials`	The Credentials Setter for OAuth 2 Bearer token
oauth2AuthorizationCodeCredentials	`Oauth2AuthorizationCodeCredentials`	The Credentials Setter for OAuth 2 Authorization Code Grant
oauth2ClientCredentialsCredentials	`Oauth2ClientCredentialsCredentials`	The Credentials Setter for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

package main

import (
    "vimeoApi"
    "vimeoApi/models"
)

func main() {
    client := vimeoApi.NewClient(
    vimeoApi.CreateConfiguration(
            vimeoApi.WithHttpConfiguration(
                vimeoApi.CreateHttpConfiguration(
                    vimeoApi.WithTimeout(30),
                ),
            ),
            vimeoApi.WithBearerCredentials(
                vimeoApi.NewBearerCredentials("AccessToken"),
            ),
            vimeoApi.WithOauth2AuthorizationCodeCredentials(
                vimeoApi.NewOauth2AuthorizationCodeCredentials(
                    "OAuthClientId",
                    "OAuthClientSecret",
                    "OAuthRedirectUri",
                ).
                WithOauthScopes([]models.OauthScopeOauth2AuthorizationCode{
        models.OauthScopeOauth2AuthorizationCode_Ai,
        models.OauthScopeOauth2AuthorizationCode_Create,
    }),
            ),
            vimeoApi.WithOauth2ClientCredentialsCredentials(
                vimeoApi.NewOauth2ClientCredentialsCredentials(
                    "OAuthClientId",
                    "OAuthClientSecret",
                ).
                WithOauthScopes([]models.OauthScopeOauth2ClientCredentials{
        models.OauthScopeOauth2ClientCredentials_Ai,
        models.OauthScopeOauth2ClientCredentials_Create,
    }),
            ),
            vimeoApi.WithLoggerConfiguration(
                vimeoApi.WithLevel("info"),
                vimeoApi.WithRequestConfiguration(
                    vimeoApi.WithRequestBody(true),
                ),
                vimeoApi.WithResponseConfiguration(
                    vimeoApi.WithResponseHeaders(true),
                ),
            ),
        ),
    )
}

Name		Name	Last commit message	Last commit date
Latest commit History 2 Commits
doc		doc
errors		errors
models		models
LICENSE		LICENSE
README.md		README.md
api_apps_webhooks_api.go		api_apps_webhooks_api.go
api_information_essentials_api.go		api_information_essentials_api.go
auth_provider.go		auth_provider.go
authentication_extras_authenticate_api.go		authentication_extras_authenticate_api.go
authentication_extras_convert_api.go		authentication_extras_convert_api.go
authentication_extras_essentials_api.go		authentication_extras_essentials_api.go
authentication_extras_exchange_api.go		authentication_extras_exchange_api.go
base_api.go		base_api.go
bearer_authentication.go		bearer_authentication.go
categories_channels_api.go		categories_channels_api.go
categories_essentials_api.go		categories_essentials_api.go
categories_groups_api.go		categories_groups_api.go
categories_users_api.go		categories_users_api.go
categories_videos_api.go		categories_videos_api.go
channels_categories_api.go		channels_categories_api.go
channels_essentials_api.go		channels_essentials_api.go
channels_moderators_api.go		channels_moderators_api.go
channels_private_channel_members_api.go		channels_private_channel_members_api.go
channels_subscriptions_and_subscribers_api.go		channels_subscriptions_and_subscribers_api.go
channels_tags_api.go		channels_tags_api.go
channels_videos_api.go		channels_videos_api.go
client.go		client.go
configuration.go		configuration.go
core.go		core.go
default_configuration.go		default_configuration.go
embed_presets_custom_logos_api.go		embed_presets_custom_logos_api.go
embed_presets_essentials_api.go		embed_presets_essentials_api.go
embed_presets_folders_api.go		embed_presets_folders_api.go
embed_presets_timeline_events_api.go		embed_presets_timeline_events_api.go
embed_presets_videos_api.go		embed_presets_videos_api.go
folders_essentials_api.go		folders_essentials_api.go
folders_items_api.go		folders_items_api.go
folders_videos_api.go		folders_videos_api.go
go.mod		go.mod
groups_essentials_api.go		groups_essentials_api.go
groups_subscriptions_api.go		groups_subscriptions_api.go
groups_users_api.go		groups_users_api.go
groups_videos_api.go		groups_videos_api.go
likes_essentials_api.go		likes_essentials_api.go
live_analytics_api.go		live_analytics_api.go
live_audio_tracks_api.go		live_audio_tracks_api.go
live_embed_privacy_api.go		live_embed_privacy_api.go
live_essentials_api.go		live_essentials_api.go
live_event_activation_api.go		live_event_activation_api.go
live_event_automated_closed_captions_api.go		live_event_automated_closed_captions_api.go
live_event_destinations_api.go		live_event_destinations_api.go
live_event_end_api.go		live_event_end_api.go
live_event_low_latency_api.go		live_event_low_latency_api.go
live_event_m_3_u_8_playback_api.go		live_event_m_3_u_8_playback_api.go
live_event_sessions_api.go		live_event_sessions_api.go
live_event_thumbnails_api.go		live_event_thumbnails_api.go
live_event_videos_api.go		live_event_videos_api.go
live_graphics_api.go		live_graphics_api.go
live_scenes_api.go		live_scenes_api.go
oauth_2_authorization_code_authentication.go		oauth_2_authorization_code_authentication.go
oauth_2_client_credentials_authentication.go		oauth_2_client_credentials_authentication.go
oauth_authorization_api.go		oauth_authorization_api.go
on_demand_backgrounds_api.go		on_demand_backgrounds_api.go
on_demand_essentials_api.go		on_demand_essentials_api.go
on_demand_genres_api.go		on_demand_genres_api.go
on_demand_posters_api.go		on_demand_posters_api.go
on_demand_promotions_api.go		on_demand_promotions_api.go
on_demand_purchases_and_rentals_api.go		on_demand_purchases_and_rentals_api.go
on_demand_regions_api.go		on_demand_regions_api.go
on_demand_seasons_api.go		on_demand_seasons_api.go
on_demand_videos_api.go		on_demand_videos_api.go
payments_essentials_api.go		payments_essentials_api.go
portfolios_essentials_api.go		portfolios_essentials_api.go
portfolios_videos_api.go		portfolios_videos_api.go
search_federated_api.go		search_federated_api.go
showcases_custom_showcase_logos_api.go		showcases_custom_showcase_logos_api.go
showcases_custom_showcase_thumbnails_api.go		showcases_custom_showcase_thumbnails_api.go
showcases_essentials_api.go		showcases_essentials_api.go
showcases_showcase_videos_api.go		showcases_showcase_videos_api.go
subscription_plans_essentials_api.go		subscription_plans_essentials_api.go
tags_essentials_api.go		tags_essentials_api.go
teams_essentials_api.go		teams_essentials_api.go
teams_members_api.go		teams_members_api.go
tutorial_essentials_api.go		tutorial_essentials_api.go
users_analytics_api.go		users_analytics_api.go
users_essentials_api.go		users_essentials_api.go
users_feeds_api.go		users_feeds_api.go
users_followers_api.go		users_followers_api.go
users_lms_api.go		users_lms_api.go
users_pictures_api.go		users_pictures_api.go
users_search_api.go		users_search_api.go
users_watch_history_api.go		users_watch_history_api.go
videos_ai_api.go		videos_ai_api.go
videos_animated_thumbnails_api.go		videos_animated_thumbnails_api.go
videos_chapters_api.go		videos_chapters_api.go
videos_content_ratings_api.go		videos_content_ratings_api.go
videos_creative_commons_api.go		videos_creative_commons_api.go
videos_credits_api.go		videos_credits_api.go
videos_embed_privacy_api.go		videos_embed_privacy_api.go
videos_essentials_api.go		videos_essentials_api.go

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

Getting Started with Vimeo API

Introduction

Requirements

Building

Install Dependencies

Installation

1. Add SDK as a Dependency to the Application

Initialize the API Client

Authorization

List of APIs

SDK Infrastructure

Configuration

Utilities

About

Releases

Packages

Contributors

Languages

Uh oh!

Folders and files

Latest commit

History

Repository files navigation

Getting Started with Vimeo API

Introduction

Requirements

Building

Install Dependencies

Installation

1. Add SDK as a Dependency to the Application

Initialize the API Client

Authorization

List of APIs

SDK Infrastructure

Configuration

Utilities

About

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages