Package video.api.client.api.clients
Class AuthenticationApi
java.lang.Object
video.api.client.api.clients.AuthenticationApi
public class AuthenticationApi
extends java.lang.Object
-
Constructor Summary
Constructors Constructor Description AuthenticationApi(ApiClient apiClient) -
Method Summary
Modifier and Type Method Description AccessTokenauthenticate(AuthenticatePayload authenticatePayload)Authenticate To get started, submit your API key in the body of your request. api.video returns an access token that is valid for one hour (3600 seconds).ApiResponse<AccessToken>authenticateWithHttpInfo(AuthenticatePayload authenticatePayload)Authenticate To get started, submit your API key in the body of your request. api.video returns an access token that is valid for one hour (3600 seconds).ApiClientgetApiClient()AccessTokenrefresh(RefreshTokenPayload refreshTokenPayload)Refresh token Use the refresh endpoint with the refresh token you received when you first authenticated using the api-key endpoint.ApiResponse<AccessToken>refreshWithHttpInfo(RefreshTokenPayload refreshTokenPayload)Refresh token Use the refresh endpoint with the refresh token you received when you first authenticated using the api-key endpoint.voidsetApiClient(ApiClient apiClient)Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
AuthenticationApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
authenticate
Authenticate To get started, submit your API key in the body of your request. api.video returns an access token that is valid for one hour (3600 seconds). A refresh token is also returned. View a [tutorial](https://api.video/blog/tutorials/authentication-tutorial) on authentication.- Parameters:
authenticatePayload- (required)- Returns:
- AccessToken
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details:
Status Code Description Response Headers 200 Success - 400 Bad Request -
-
authenticateWithHttpInfo
public ApiResponse<AccessToken> authenticateWithHttpInfo(AuthenticatePayload authenticatePayload) throws ApiExceptionAuthenticate To get started, submit your API key in the body of your request. api.video returns an access token that is valid for one hour (3600 seconds). A refresh token is also returned. View a [tutorial](https://api.video/blog/tutorials/authentication-tutorial) on authentication.- Parameters:
authenticatePayload- (required)- Returns:
- ApiResponse<AccessToken>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details:
Status Code Description Response Headers 200 Success - 400 Bad Request -
-
refresh
Refresh token Use the refresh endpoint with the refresh token you received when you first authenticated using the api-key endpoint. Send the refresh token in the body of your request. The api.video API returns a new access token that is valid for one hour (3600 seconds) and a new refresh token.- Parameters:
refreshTokenPayload- (required)- Returns:
- AccessToken
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details:
Status Code Description Response Headers 200 Success - 400 Bad Request -
-
refreshWithHttpInfo
public ApiResponse<AccessToken> refreshWithHttpInfo(RefreshTokenPayload refreshTokenPayload) throws ApiExceptionRefresh token Use the refresh endpoint with the refresh token you received when you first authenticated using the api-key endpoint. Send the refresh token in the body of your request. The api.video API returns a new access token that is valid for one hour (3600 seconds) and a new refresh token.- Parameters:
refreshTokenPayload- (required)- Returns:
- ApiResponse<AccessToken>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details:
Status Code Description Response Headers 200 Success - 400 Bad Request -
-