Package com.ingenico.sdk.apimanagement

API Management provides a way to request access to the Ingenico APIs.

See: Description

Interface Summary

Interface	Description
IApiManagement	Access to the Ingenico APIs access control service.

Class Summary

Class	Description
ApiManagement	Access to the Ingenico APIs access control service.
ApiManagementToken	Deprecated IApiManagement.getUsageToken() won't return an instance of this class anymore.

Package com.ingenico.sdk.apimanagement Description

API Management provides a way to request access to the Ingenico APIs.

In order to use the Ingenico API on an Ingenico terminal, the Android application must first subscribe with an initial token provided by Ingenico. The IApiManagement.subscribe(java.lang.String) method is used to access the API management service embedded on the terminal. When a call to this method is done, the service will do the following:

• The initial token passed as an argument is sent to the API management server.
• If the token is valid, the API management server sends back an usage token.
• The service sends this usage token to Tetra (the secured payment module connected to the Android tablet).
• The Tetra API management service gives authorization to use the corresponding APIs to the Android application which called the subscribe method.

Once a token has been successfully registered, all authorized APIs will now be accessible to the Android application until the usage token expired. A timestamp is returned by the subscribe method. Once this time limit for the validity period is reached, the subscribe method must be called again in order to get a renewal of the APIs access rights again.

If an error is returned by the subscribe method, or if an API is called without authorization, an ApiManagementException will be thrown.

Once a first subscribe request has been successful, it is possible to retrieve the usage token with the IApiManagement.getUsageToken() method. Only one usage token is available for an Android application at a time. Forcing the renewal of the token using a new isvRecord value or the forceRenewal parameter will change the value of the usage token. Using a new initial token will also trigger a renewal of the usage token, and can also change the access rights of the Android application.