The following parameters are configurable for the API Client:
| Parameter | Type | Description |
|---|---|---|
| httpClientConfig | Consumer<HttpClientConfiguration.Builder> |
Set up Http Client Configuration instance. |
| loggingConfig | Consumer<ApiLoggingConfiguration.Builder> |
Set up Logging Configuration instance. |
| 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:
import com.vimeo.api.VimeoApiClient;
import com.vimeo.api.authentication.BearerModel;
import com.vimeo.api.authentication.Oauth2AuthorizationCodeModel;
import com.vimeo.api.authentication.Oauth2ClientCredentialsModel;
import com.vimeo.api.exceptions.ApiException;
import com.vimeo.api.http.response.ApiResponse;
import com.vimeo.api.models.OauthScopeOauth2AuthorizationCode;
import com.vimeo.api.models.OauthScopeOauth2ClientCredentials;
import com.vimeo.api.models.OauthToken;
import java.io.IOException;
import java.util.Arrays;
import org.slf4j.event.Level;
public class Program {
public static void main(String[] args) {
VimeoApiClient client = new VimeoApiClient.Builder()
.loggingConfig(builder -> builder
.level(Level.DEBUG)
.requestConfig(logConfigBuilder -> logConfigBuilder.body(true))
.responseConfig(logConfigBuilder -> logConfigBuilder.headers(true)))
.httpClientConfig(configBuilder -> configBuilder
.timeout(0))
.bearerCredentials(new BearerModel.Builder(
"AccessToken"
)
.build())
.oauth2AuthorizationCodeCredentials(new Oauth2AuthorizationCodeModel.Builder(
"OAuthClientId",
"OAuthClientSecret",
"OAuthRedirectUri"
)
.oauthScopes(Arrays.asList(
OauthScopeOauth2AuthorizationCode.AI,
OauthScopeOauth2AuthorizationCode.CREATE
))
.build())
.oauth2ClientCredentialsCredentials(new Oauth2ClientCredentialsModel.Builder(
"OAuthClientId",
"OAuthClientSecret"
)
.oauthScopes(Arrays.asList(
OauthScopeOauth2ClientCredentials.AI,
OauthScopeOauth2ClientCredentials.CREATE
))
.build())
.build();
}
}The gateway for the SDK. This class acts as a factory for the Apis and also holds the configuration of the SDK.
| Name | Description | Return Type |
|---|---|---|
getApiAppsWebhooksApi() |
Provides access to ApiAppsWebhooks controller. | ApiAppsWebhooksApi |
getApiInformationEssentialsApi() |
Provides access to ApiInformationEssentials controller. | ApiInformationEssentialsApi |
getAuthenticationExtrasAuthenticateApi() |
Provides access to AuthenticationExtrasAuthenticate controller. | AuthenticationExtrasAuthenticateApi |
getAuthenticationExtrasConvertApi() |
Provides access to AuthenticationExtrasConvert controller. | AuthenticationExtrasConvertApi |
getAuthenticationExtrasEssentialsApi() |
Provides access to AuthenticationExtrasEssentials controller. | AuthenticationExtrasEssentialsApi |
getAuthenticationExtrasExchangeApi() |
Provides access to AuthenticationExtrasExchange controller. | AuthenticationExtrasExchangeApi |
getCategoriesChannelsApi() |
Provides access to CategoriesChannels controller. | CategoriesChannelsApi |
getCategoriesEssentialsApi() |
Provides access to CategoriesEssentials controller. | CategoriesEssentialsApi |
getCategoriesGroupsApi() |
Provides access to CategoriesGroups controller. | CategoriesGroupsApi |
getCategoriesUsersApi() |
Provides access to CategoriesUsers controller. | CategoriesUsersApi |
getCategoriesVideosApi() |
Provides access to CategoriesVideos controller. | CategoriesVideosApi |
getChannelsCategoriesApi() |
Provides access to ChannelsCategories controller. | ChannelsCategoriesApi |
getChannelsEssentialsApi() |
Provides access to ChannelsEssentials controller. | ChannelsEssentialsApi |
getChannelsModeratorsApi() |
Provides access to ChannelsModerators controller. | ChannelsModeratorsApi |
getChannelsPrivatechannelmembersApi() |
Provides access to ChannelsPrivatechannelmembers controller. | ChannelsPrivatechannelmembersApi |
getChannelsSubscriptionsandsubscribersApi() |
Provides access to ChannelsSubscriptionsandsubscribers controller. | ChannelsSubscriptionsandsubscribersApi |
getChannelsTagsApi() |
Provides access to ChannelsTags controller. | ChannelsTagsApi |
getChannelsVideosApi() |
Provides access to ChannelsVideos controller. | ChannelsVideosApi |
getEmbedPresetsCustomlogosApi() |
Provides access to EmbedPresetsCustomlogos controller. | EmbedPresetsCustomlogosApi |
getEmbedPresetsEssentialsApi() |
Provides access to EmbedPresetsEssentials controller. | EmbedPresetsEssentialsApi |
getEmbedPresetsFoldersApi() |
Provides access to EmbedPresetsFolders controller. | EmbedPresetsFoldersApi |
getEmbedPresetsTimelineeventsApi() |
Provides access to EmbedPresetsTimelineevents controller. | EmbedPresetsTimelineeventsApi |
getEmbedPresetsVideosApi() |
Provides access to EmbedPresetsVideos controller. | EmbedPresetsVideosApi |
getFoldersEssentialsApi() |
Provides access to FoldersEssentials controller. | FoldersEssentialsApi |
getFoldersItemsApi() |
Provides access to FoldersItems controller. | FoldersItemsApi |
getFoldersVideosApi() |
Provides access to FoldersVideos controller. | FoldersVideosApi |
getGroupsEssentialsApi() |
Provides access to GroupsEssentials controller. | GroupsEssentialsApi |
getGroupsSubscriptionsApi() |
Provides access to GroupsSubscriptions controller. | GroupsSubscriptionsApi |
getGroupsUsersApi() |
Provides access to GroupsUsers controller. | GroupsUsersApi |
getGroupsVideosApi() |
Provides access to GroupsVideos controller. | GroupsVideosApi |
getLikesEssentialsApi() |
Provides access to LikesEssentials controller. | LikesEssentialsApi |
getLiveAnalyticsApi() |
Provides access to LiveAnalytics controller. | LiveAnalyticsApi |
getLiveAudiotracksApi() |
Provides access to LiveAudiotracks controller. | LiveAudiotracksApi |
getLiveEmbedprivacyApi() |
Provides access to LiveEmbedprivacy controller. | LiveEmbedprivacyApi |
getLiveEssentialsApi() |
Provides access to LiveEssentials controller. | LiveEssentialsApi |
getLiveEventM3U8PlaybackApi() |
Provides access to LiveEventM3U8Playback controller. | LiveEventM3U8PlaybackApi |
getLiveEventactivationApi() |
Provides access to LiveEventactivation controller. | LiveEventactivationApi |
getLiveEventautomatedclosedcaptionsApi() |
Provides access to LiveEventautomatedclosedcaptions controller. | LiveEventautomatedclosedcaptionsApi |
getLiveEventdestinationsApi() |
Provides access to LiveEventdestinations controller. | LiveEventdestinationsApi |
getLiveEventendApi() |
Provides access to LiveEventend controller. | LiveEventendApi |
getLiveEventlowlatencyApi() |
Provides access to LiveEventlowlatency controller. | LiveEventlowlatencyApi |
getLiveEventsessionsApi() |
Provides access to LiveEventsessions controller. | LiveEventsessionsApi |
getLiveEventthumbnailsApi() |
Provides access to LiveEventthumbnails controller. | LiveEventthumbnailsApi |
getLiveEventvideosApi() |
Provides access to LiveEventvideos controller. | LiveEventvideosApi |
getLiveGraphicsApi() |
Provides access to LiveGraphics controller. | LiveGraphicsApi |
getLiveScenesApi() |
Provides access to LiveScenes controller. | LiveScenesApi |
getOnDemandBackgroundsApi() |
Provides access to OnDemandBackgrounds controller. | OnDemandBackgroundsApi |
getOnDemandEssentialsApi() |
Provides access to OnDemandEssentials controller. | OnDemandEssentialsApi |
getOnDemandGenresApi() |
Provides access to OnDemandGenres controller. | OnDemandGenresApi |
getOnDemandPostersApi() |
Provides access to OnDemandPosters controller. | OnDemandPostersApi |
getOnDemandPromotionsApi() |
Provides access to OnDemandPromotions controller. | OnDemandPromotionsApi |
getOnDemandPurchasesandrentalsApi() |
Provides access to OnDemandPurchasesandrentals controller. | OnDemandPurchasesandrentalsApi |
getOnDemandRegionsApi() |
Provides access to OnDemandRegions controller. | OnDemandRegionsApi |
getOnDemandSeasonsApi() |
Provides access to OnDemandSeasons controller. | OnDemandSeasonsApi |
getOnDemandVideosApi() |
Provides access to OnDemandVideos controller. | OnDemandVideosApi |
getPaymentsEssentialsApi() |
Provides access to PaymentsEssentials controller. | PaymentsEssentialsApi |
getPortfoliosEssentialsApi() |
Provides access to PortfoliosEssentials controller. | PortfoliosEssentialsApi |
getPortfoliosVideosApi() |
Provides access to PortfoliosVideos controller. | PortfoliosVideosApi |
getSearchFederatedApi() |
Provides access to SearchFederated controller. | SearchFederatedApi |
getShowcasesCustomshowcaselogosApi() |
Provides access to ShowcasesCustomshowcaselogos controller. | ShowcasesCustomshowcaselogosApi |
getShowcasesCustomshowcasethumbnailsApi() |
Provides access to ShowcasesCustomshowcasethumbnails controller. | ShowcasesCustomshowcasethumbnailsApi |
getShowcasesEssentialsApi() |
Provides access to ShowcasesEssentials controller. | ShowcasesEssentialsApi |
getShowcasesShowcasevideosApi() |
Provides access to ShowcasesShowcasevideos controller. | ShowcasesShowcasevideosApi |
getSubscriptionPlansEssentialsApi() |
Provides access to SubscriptionPlansEssentials controller. | SubscriptionPlansEssentialsApi |
getTagsEssentialsApi() |
Provides access to TagsEssentials controller. | TagsEssentialsApi |
getTeamsEssentialsApi() |
Provides access to TeamsEssentials controller. | TeamsEssentialsApi |
getTeamsMembersApi() |
Provides access to TeamsMembers controller. | TeamsMembersApi |
getTutorialEssentialsApi() |
Provides access to TutorialEssentials controller. | TutorialEssentialsApi |
getUsersAnalyticsApi() |
Provides access to UsersAnalytics controller. | UsersAnalyticsApi |
getUsersEssentialsApi() |
Provides access to UsersEssentials controller. | UsersEssentialsApi |
getUsersFeedsApi() |
Provides access to UsersFeeds controller. | UsersFeedsApi |
getUsersFollowersApi() |
Provides access to UsersFollowers controller. | UsersFollowersApi |
getUsersLmsApi() |
Provides access to UsersLms controller. | UsersLmsApi |
getUsersPicturesApi() |
Provides access to UsersPictures controller. | UsersPicturesApi |
getUsersSearchApi() |
Provides access to UsersSearch controller. | UsersSearchApi |
getUsersWatchhistoryApi() |
Provides access to UsersWatchhistory controller. | UsersWatchhistoryApi |
getVideosAiApi() |
Provides access to VideosAi controller. | VideosAiApi |
getVideosAnimatedthumbnailsApi() |
Provides access to VideosAnimatedthumbnails controller. | VideosAnimatedthumbnailsApi |
getVideosChaptersApi() |
Provides access to VideosChapters controller. | VideosChaptersApi |
getVideosContentratingsApi() |
Provides access to VideosContentratings controller. | VideosContentratingsApi |
getVideosCreativeCommonsApi() |
Provides access to VideosCreativeCommons controller. | VideosCreativeCommonsApi |
getVideosCreditsApi() |
Provides access to VideosCredits controller. | VideosCreditsApi |
getVideosEmbedprivacyApi() |
Provides access to VideosEmbedprivacy controller. | VideosEmbedprivacyApi |
getVideosEssentialsApi() |
Provides access to VideosEssentials controller. | VideosEssentialsApi |
getVideosFragmentsApi() |
Provides access to VideosFragments controller. | VideosFragmentsApi |
getVideosLanguagesApi() |
Provides access to VideosLanguages controller. | VideosLanguagesApi |
getVideosLiveM3U8PlaybackApi() |
Provides access to VideosLiveM3U8Playback controller. | VideosLiveM3U8PlaybackApi |
getVideosModerationApi() |
Provides access to VideosModeration controller. | VideosModerationApi |
getVideosNondestructivetrimmingApi() |
Provides access to VideosNondestructivetrimming controller. | VideosNondestructivetrimmingApi |
getVideosRecommendationsApi() |
Provides access to VideosRecommendations controller. | VideosRecommendationsApi |
getVideosShowcasesApi() |
Provides access to VideosShowcases controller. | VideosShowcasesApi |
getVideosTagsApi() |
Provides access to VideosTags controller. | VideosTagsApi |
getVideosTexttracksApi() |
Provides access to VideosTexttracks controller. | VideosTexttracksApi |
getVideosThumbnailsApi() |
Provides access to VideosThumbnails controller. | VideosThumbnailsApi |
getVideosTranscriptsApi() |
Provides access to VideosTranscripts controller. | VideosTranscriptsApi |
getVideosUnlistedvideosApi() |
Provides access to VideosUnlistedvideos controller. | VideosUnlistedvideosApi |
getVideosUploadsApi() |
Provides access to VideosUploads controller. | VideosUploadsApi |
getVideosVersionsApi() |
Provides access to VideosVersions controller. | VideosVersionsApi |
getVideosVideocommentsApi() |
Provides access to VideosVideocomments controller. | VideosVideocommentsApi |
getWatchLaterQueueEssentialsApi() |
Provides access to WatchLaterQueueEssentials controller. | WatchLaterQueueEssentialsApi |
getOauthAuthorizationApi() |
Provides access to OauthAuthorization controller. | OauthAuthorizationApi |
| Name | Description | Return Type |
|---|---|---|
shutdown() |
Shutdown the underlying HttpClient instance. | void |
getEnvironment() |
Current API environment. | Environment |
getHttpClient() |
The HTTP Client instance to use for making HTTP requests. | HttpClient |
getHttpClientConfig() |
Http Client Configuration instance. | ReadonlyHttpClientConfiguration |
getLoggingConfig() |
Logging Configuration instance. | ReadonlyLoggingConfiguration |
getBearerCredentials() |
The credentials to use with Bearer. | BearerCredentials |
getOauth2AuthorizationCodeCredentials() |
The credentials to use with Oauth2AuthorizationCode. | Oauth2AuthorizationCodeCredentials |
getOauth2ClientCredentialsCredentials() |
The credentials to use with Oauth2ClientCredentials. | Oauth2ClientCredentialsCredentials |
getBaseUri(Server server) |
Get base URI by current environment | String |
getBaseUri() |
Get base URI by current environment | String |