A handful of classes to help you interact with the Salt Edge API from your Android app.
Current SDK is based on Salt Edge API v5.
When you migrating to the new Salt Edge Android SDK, please read carefully CHANGELOG since many changes have been made.
- Android 4.0.2+ (minimum 15 sdk version) with Play Services installed
- Client ID and App Secrets
Warning! The SDK doesn't work without Client ID and App Secret! Note: You can find your Client ID and App Secret on your profile page.
Clone this repository
$ git clone [email protected]:saltedge/saltedge-android.git
Add Java 8 support
android {
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}Add maven repository
repositories {
maven {
url 'https://raw.github.com/saltedge/saltedge-android/master/repo/'
}
}Add SDK dependency
implementation 'com.saltedge.sdk:saltedge-library:2.0.0@aar'Saltedge SDK library require extra dependencies:
implementation 'com.google.android.gms:play-services-safetynet:16.0.0'//Security utils
implementation 'com.squareup.retrofit2:retrofit:2.5.0'//Network communication
implementation 'com.squareup.retrofit2:converter-gson:2.5.0'//model serializer/deserializer
implementation 'com.squareup.okhttp3:logging-interceptor:3.12.2'//Network communication logging- Replace the
clientAppId,clientAppSecretconstants in StartActivity:43-44 with your Client ID and corresponding App secret. - Add the
customerIdentifier(that uniquely identifies a customer) to StartActivity.java:42 - Run the app
Note: You can find your Client ID and App secret on your profile page.
Open Android Studio and create a new app.
Add module (Android Studio -> File -> Import Module -> find module named "saltedge-library" -> Import)
or add external dependency (implementation 'com.saltedge.sdk:saltedge-library:x.x.x@aar')
Before any usage of SDK you should provide clientAppId and clientAppSecret.
SaltEdgeSDK.getInstance().init(applicationContext, clientAppId, clientAppSecret);or provide clientAppId and clientAppSecret and set http logging is enabled or not
SaltEdgeSDK.getInstance().init(applicationContext, clientAppId, clientAppSecret, loggingIsEnabled);You should create customer and get customer secret token.
Params:
- customerIdentifier - Random string which identify user on current app instance
private void createCustomer() {
String customerIdentifier = "customerIdentifier";
SERequestManager.getInstance().createCustomer(customerIdentifier, new CreateCustomerResult() {
@Override
public void onSuccess(String secret) {
//save customer secret
}
@Override
public void onFailure(String errorResponse) {
//process error
}
});
} public static void fetchProviders() {
String countryCode = "XX";//prefered country code or null
SERequestManager.getInstance().fetchProviders(countryCode, new ProvidersConnector.Result() {
@Override
public void onSuccess(ArrayList<SEProvider> providersList) {
//use providers list
}
@Override
public void onFailure(String errorResponse) {
//process error
}
});
}Once we have the Customer Secret, we can create a connection using Salt Edge Connect, which already implemented the interface in a fast and secure way Params:
- customer secret
- provider code (SEProvider)
- consent scope (e.g.
holder_information,account_details,transactions_details) - locale code (by default "en")
- return Url - the custom URL the user will be redirected to on connect finish
private void createConnectSession(String customerSecret, SEProvider selectedProvider, String localeCode, String returnUrl) {
String providerCode = selectedProvider.getCode();
String[] CONSENT_SCOPES = { SEConsent.SCOPE_ACCOUNT_DETAILS, SEConsent.SCOPE_TRANSACTIONS_DETAILS };
SERequestManager.getInstance().createConnectSession(
customerSecret,
providerCode,
CONSENT_SCOPES,
localeCode,
returnUrl,
new ConnectSessionResult() {
@Override
public void onSuccess(String connectUrl) {
// connectUrl - This is the url you should visit to create the connection.
}
@Override
public void onFailure(String errorMessage) {
//process error
}
});
}or call createConnectSession(...) with custom map of params
private void createConnectSession(String customerSecret, SEProvider selectedProvider, String localeCode, String returnUrl) {
HashMap<String, Object> dataMap = new HashMap<>();
String providerCode = selectedProvider.getCode();
dataMap.put("provider_code", providerCode);
...
dataMap.put("return_to", "custom return url");
SERequestManager.getInstance().createConnectSession(
customerSecret,
dataMap,
new ConnectSessionResult() {
@Override
public void onSuccess(String connectUrl) {
// connectUrl - This is the url you should visit to create the connection.
}
@Override
public void onFailure(String errorMessage) {
//process error
}
});
}Using the returned URL, you can let the user import their data. After doing this, you will obtain a connectionSecret.
private void goToURL(String connectUrl, String returnUrl, View view) {
WebView webView = (WebView) view.findViewById(R.id.webView);
SEWebViewTools.getInstance().initializeWithUrl(activityContext, webView, connectUrl, returnUrl,
new SEWebViewTools.WebViewRedirectListener() {
@Override
public void onConnectSessionSuccess(String connectionId, String connectionSecret, String stage) {
//connection finished sucessfully. save connectionId and connectionSecret.
}
@Override
public void onConnectSessionError(String stage) {
//connection finished with error. Show the error.
}
@Override
public void onConnectionUpdate() {
//Connection model updated due to some actions
}
@Override
public void onConnectSessionStageChange(String connectionId, String connectionSecret, String stage, String apiStage) {
//connection is on fetching stage. save connectionId and connectionSecret for connection process resume.
}
});
}Possible stage values for each callback type are fetching, success and error.
Parameter api_stage shows detailed information of the fetching process.
Possible api_stage values are attempts stages: start, connect, interactive, fetch_holder_info, fetch_accounts, fetch_recent, fetch_full, disconnect, finish.
connectionSecret can be used to get the status of the Connection, its accounts and transactions.
SERequestManager.getInstance().fetchConnection(
customerSecret,
connectionSecret,
new FetchConnectionsResult() {
@Override
public void onSuccess(List<SEConnection> connections) {
//show connections
}
@Override
public void onFailure(String errorResponse) {
//process error
}
});You can now get all the accounts of the login using the connectionSecret.
SERequestManager.getInstance().fetchAccounts(
customerSecret,
connectionSecret,
new FetchAccountsResult() {
@Override
public void onSuccess(ArrayList<SEAccount> accounts) {
//show accounts
}
@Override
public void onFailure(String errorResponse) {
//process error
}
});For each accounts, you can obtain the list of all transactions.
SERequestManager.getInstance().fetchAllTransactions(
customerSecret,
connectionSecret,
accountId,
new FetchTransactionsResult() {
@Override
public void onSuccess(ArrayList<SETransaction> transactions) {
//show transactions
}
@Override
public void onFailure(String errorResponse) {
//process error
}
});For each accounts, you can obtain the list of all new transactions from specified ID.
SERequestManager.getInstance().fetchAllTransactions(
customerSecret,
connectionSecret,
accountId,
fromId,
new FetchTransactionsResult() {
@Override
public void onSuccess(ArrayList<SETransaction> transactions) {
//show transactions
}
@Override
public void onFailure(String errorResponse) {
//process error
}
});For each accounts, you can obtain the list of all pending transactions.
SERequestManager.getInstance().fetchPendingTransactionsOfAccount(
customerSecret,
connectionSecret,
accountId,
new FetchTransactionsResult() {
@Override
public void onSuccess(ArrayList<SETransaction> transactions) {
//show transactions
}
@Override
public void onFailure(String errorResponse) {
//process error
}
});You can refresh the data for a connection. To refresh, you should obtain a connectUrl of Salt Edge Connect.
SERequestManager.getInstance().createRefreshSession(
customerSecret,
connectionSecret,
localeCode,
returnUrl,
new ConnectSessionResult() {
@Override
public void onSuccess(String connectUrl) {
// here is a URL you can use to redirect the user
}
@Override
public void onFailure(String errorMessage) {
//process error
}
});You can reconnect the connection. You should obtain a connectUrl of Salt Edge Connect.
SERequestManager.getInstance().createReconnectSession(
customerSecret,
connectionSecret,
consentScopes,
localeCode,
callbackUrl,
new ConnectSessionResult() {
@Override
public void onSuccess(String connectUrl) {
// here is a URL you can use to redirect the user
}
@Override
public void onFailure(String errorMessage) {
//process error
}
}); SERequestManager.getInstance().deleteConnection(
customerSecret,
connectionSecret,
new DeleteEntryResult() {
@Override
public void onSuccess(Boolean isRemoved) {
//show changes
}
@Override
public void onFailure(String errorResponse) {
//process error
}
});If you wish to refresh Connection without Salt Edge Connect Form, you can special service SERefreshService.
- connectionData - SEConnection object
- consentScopes - refreshing scopes array (e.g. { SEConsent.SCOPE_ACCOUNT_DETAILS, SEConsent.SCOPE_TRANSACTIONS_DETAILS } )
SERefreshService refreshService = SERequestManager.getInstance().refreshConnectionWithSecret(
customerSecret,
connectionData,
consentScoopes,
refreshResultCallback); refreshService.cancel(); private RefreshConnectionResult callback = new RefreshConnectionResult() {
@Override
public void onRefreshSuccess() {
//refresh finished with success
}
@Override
public void onRefreshFailure(String errorMessage) {
//refresh finished with error
}
@Override
public void onConnectionStateFetchError(String errorMessage) {
//login state updte finishe with error. you can ignore it
}
@Override
public void provideInteractiveData(SEStage lastStage) {
//This callback is called when the currently fetching login requires any interactive credentials for fetching.
// call `refreshService.sendInteractiveData(credentials)` when credentials are ready
}
} refreshService.sendInteractiveData(credentials);Credentials is Map<String, Object> type with content like "interactive field name from StageData": "input value".
Saltedge Connect API requires high security standards for data handling on client’s side. This method is only available for the certified and/or selected partners. For more information, feel free to contact us
Please consult the Demo app to see how it works
SERequestManager.getInstance().fetchConsents(
customerSecret,
connectionSecret,
new FetchConsentsResult() {
@Override
public void onSuccess(List<SEConsent> consents) {
//show consents
}
@Override
public void onFailure(String errorResponse) {
//process error
}
}); SERequestManager.getInstance().fetchConsents(
customerSecret,
connectionSecret,
consentId,
new DeleteEntryResult() {
@Override
public void onSuccess(Boolean isRemoved) {
//show changes
}
@Override
public void onFailure(String errorResponse) {
//process error
}
});There are some provided models for serializing the objects received in the API responses. These represent the providers, logins, accounts, transactions, provider fields and their options. Whenever you request a resource that returns one of these types, they will always get serialized into Java classes. (For instance, the listingTransactionsOfAccount(...) method has a ArrayList<> containing SETransaction instances in its success callback.)
Base models contained within the components:
- SEProvider
- SECustomer
- SEConnection
- SEAccount
- SETransaction
- SEConsent
- SEAttempt
- SEStage
Stage contains interactive fields name and options which should be used for credentials input.
Possible values of the name of the stage:
start,connect,interactive,fetch_holder_info,fetch_accounts,fetch_recent,fetch_full,disconnect,finish.
For a supplementary description of the models listed above that is not included in the sources' docs, feel free to visit the API Reference.
A few utility classes are bundled within the components, and are used internally, but you could also use them if you find that necessary.
See the LICENSE file.