com.ingenico.sdk.apimanagement

Interface IApiManagement

All Superinterfaces:

IIngenicoApi

All Known Implementing Classes:

ApiManagement

public interface IApiManagement
extends IIngenicoApi

Access to the Ingenico APIs access control service.

Example:

IApiManagement apiManagement = ApiManagement.getInstance(context);
try {
    // Replace "mysecretkey" with your initial token for API management
    apiManagement.subscribe("mysecretkey");
} catch (IngenicoException e) {
    // Handle exception
}

Method Summary

Modifier and Type	Method and Description
ApiManagementToken	getUsageToken() Deprecated. Since version 2.12.0, this method will always throw an exception.
long	subscribe(java.lang.String apiKey) Request a new token and register it for API usage.
long	subscribe(java.lang.String apiKey, boolean forceRenewal) Request a new token and register it for API usage.
long	subscribe(java.lang.String apiKey, java.lang.String isvRecord) Request a new token and register it for API usage.
long	subscribe(java.lang.String apiKey, java.lang.String isvRecord, boolean forceRenewal) Request a new token and register it for API usage.

Methods inherited from interface com.ingenico.sdk.IIngenicoApi

connect, disconnect, isConnected

Method Detail

subscribe

long subscribe(java.lang.String apiKey)
        throws IngenicoException

Request a new token and register it for API usage.

This method make network requests and can be blocking, it must NOT be called from the main thread.

Parameters:

apiKey - the secret authenticating the registered right to use the API set

Returns:

a timestamp for the expiration of the token

Throws:

IngenicoException - errors subscribing to the API management, see message for details

subscribe

long subscribe(java.lang.String apiKey,
               java.lang.String isvRecord)
        throws IngenicoException

Request a new token and register it for API usage.

This method make network requests and can be blocking, it must NOT be called from the main thread.

Parameters:

apiKey - the secret authenticating the registered right to use the API set

isvRecord - an ISV defined record (json) containing detailed information on its application installation and configuration (this information can be used later to associate the token request to ISV own billing system).

Returns:

a timestamp for the expiration of the token

Throws:

IngenicoException - errors subscribing to the API management, see message for details

subscribe

long subscribe(java.lang.String apiKey,
               boolean forceRenewal)
        throws IngenicoException

Request a new token and register it for API usage.

This method make network requests and can be blocking, it must NOT be called from the main thread.

If forceRenewal is true, a new usage token with an updated expiration date will be requested on the token server. If false, the previous token is reused if not expired, or a new token will be requested.

Parameters:

apiKey - the secret authenticating the registered right to use the API set

forceRenewal - set true to ensure the renewal of the existing token

Returns:

a timestamp for the expiration of the token

Throws:

IngenicoException - errors subscribing to the API management, see message for details

subscribe

long subscribe(java.lang.String apiKey,
               java.lang.String isvRecord,
               boolean forceRenewal)
        throws IngenicoException

Request a new token and register it for API usage.

This method make network requests and can be blocking, it must NOT be called from the main thread.

If forceRenewal is true, a new usage token with an updated expiration date will be requested on the token server. If false, the previous token is reused if not expired, or a new token will be requested.

Parameters:

apiKey - the secret authenticating the registered right to use the API set

isvRecord - an ISV defined record (json) containing detailed information on its application installation and configuration (this information can be used later to associate the token request to ISV own billing system)

forceRenewal - set true to ensure the renewal of the existing token

Returns:

a timestamp for the expiration of the token

Throws:

IngenicoException - errors subscribing to the API management, see message for details

getUsageToken

@Deprecated
ApiManagementToken getUsageToken()
                                      throws IngenicoException

Deprecated. Since version 2.12.0, this method will always throw an exception.

Request the current usage token for the current application.

Returns:

Throws:

IngenicoException