Interface AuthenticationRetrofitApi
public interface AuthenticationRetrofitApi
Available methods for the Authentication API.
- Since:
- 1/6/15
-
Method Summary
Modifier and TypeMethodDescriptionvoid
loginOperatorWithAuthenticationHeader
(String authorizationHeader, APIRetrofitCallback<Token> handler) Method that will login a operator, returning a token to make the requestvoid
loginUserWithAuthenticationHeader
(String authorizationHeader, APIRetrofitCallback<User> handler) Method that will login a user, returning a User to make the requestvoid
Method that will logout the user wit the current token from the exxtractor.void
logOutSession
(String token, retrofit.Callback<retrofit.client.Response> handler) Method that will logout the user and close the session with the current token from the exxtractor.
-
Method Details
-
loginUserWithAuthenticationHeader
@POST("/exxtractor/api/v2/login") void loginUserWithAuthenticationHeader(@Header("Authorization") String authorizationHeader, APIRetrofitCallback<User> handler) Method that will login a user, returning a User to make the request- Parameters:
authorizationHeader
- the authorization header used to log the user into the systemhandler
- handler that will manage the request status
-
loginOperatorWithAuthenticationHeader
@POST("/controller/api/v3/operator-login") void loginOperatorWithAuthenticationHeader(@Header("Authorization") String authorizationHeader, APIRetrofitCallback<Token> handler) Method that will login a operator, returning a token to make the request- Parameters:
authorizationHeader
- the authorization header used to log the user into the systemhandler
- handler that will manage the request status
-
logOutSession
@POST("/controller/api/v3/logout") void logOutSession(@Header("x-access-tokens") String token, retrofit.Callback<retrofit.client.Response> handler) Method that will logout the user and close the session with the current token from the exxtractor.- Parameters:
token
- the token that will be used logged outhandler
- the handler for the request status
-
logOut
@POST("/exxtractor/api/v2/logout") void logOut(@Query("token") String token, retrofit.Callback<retrofit.client.Response> handler) Method that will logout the user wit the current token from the exxtractor.- Parameters:
token
- the token that will be used logged outhandler
- the handler for the request status
-