Note - AppFlow v2 is now released!
AEVI AppFlow is a solution that enables a client application to initiate a flow that consists of one to many stages in which any number of applications may be called. A set of input and output data structures are defined for each stage, allowing applications to view the latest state and/or augment it.
The point of sale (POS) Android SDK for AEVI AppFlow applies this solution to Android "SmartPOS" devices, allowing a POS application to initiate various flows for common operations such as payments, refunds, voids etc. In addition to calling standard payment applications, any number of value added services can be called during the flow, such as loyalty, split bill, receipt delivery and much more. AppFlow for POS is highly configurable and flexible, allowing dynamic configuration of flows and input / output data.
The SDK consists of two APIs - one for client/POS applications to initiate flows and one for value added services and payment applications to integrate into those flows.
Please see the Wiki for detailed information of how AppFlow works and development guidelines.
In order to test AppFlow and/or integrate with it, you will need to install these two AEVI provided applications;
- AEVI Flow Processing Service (FPS), which implements the APIs and executes the flows
- AEVI Developer Config Provider, which provides the flows and other settings for AppFlow
Please download the latest developer bundle from here, which contains these applications as well as the latest samples.
In your root project build.gradle file, you'll need to include our public bintray repository in the repositories section.
repositories {
maven {
url "http://dl.bintray.com/aevi/aevi-uk"
}
}
These APIs require that your application is compiled with Java 8. Ensure that your application build.gradle android DSL contains the following.
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
Use the latest version defined below.
Note - please ensure you read the Application Guidelines at a minimum before attempting to create an application for AppFlow.
For client/POS applications to initiate flows.
implementation 'com.aevi.sdk.pos.flow:payment-initiation-api:<version>'
For value added services and payment applications to integrate into flows.
implementation 'com.aevi.sdk.pos.flow:payment-flow-service-api:<version>'
The AppFlow APIs themselves are designed to facilitate communication between applications via a defined set of data structures. They are however decoupled from what the values or content of these data structures are, in order to keep them as flexible and configurable as possible. Instead, the data values are defined on the wiki and provided as constants via a separate library.
This library is stored in a separate repo here. You can find the latest version details and view the defined data constants there.
To include these in your project use
implementation `com.aevi.sdk.flow:api-constants:<version>'
There are three code samples in this repository to illustrate the use of the APIs. Please see
PaymentInitiationSamplefor an example of how to build an application that initiates payments via thePayment Initiation APIFlowServiceSamplefor an example of how to build a value added service that integrates withPayment Flow Service APIPaymentServiceSamplefor an example of how to build a payment application that integrates withPayment Flow Service API
In addition to illustrating how the APIs can be used, these samples can also be used to test your own application.
If you are building a POS app, you will want to use the FlowServiceSample and PaymentServiceSample to perform testing with apps in the flow.
In a similar manner, if you are developing a flow app or a payment app, you will want to use the PaymentInitiationSample to initiate payments.
You can of course modify these samples to suit your use cases and scenarios.
Some of the features provided by this API are configurable by AEVI and/or the acquirer.
The PaymentSettings model provides access to relevant settings and can be retrieved via PaymentClient.getPaymentSettings().
See FpsSettings for details on all the parameters.
You can check what the settings are via the System overview screen in the Payment Initiation Sample.
The minimum versions for importing / building this API are
- Gradle v4.4 (v4.8+ recommended)
- Android Gradle Plugin v3.1.3
- Android Studio v3.1.3
The API and applications use Gradle v4.8 for building. Due to a bug in this version building in Android Studio (v3.1.3 at time of writing) will cause the following error:
Configuration on demand is not supported by the current version of the Android Gradle plugin since you are using Gradle version 4.6 or above. Suggestion: disable configuration on demand by setting org.gradle.configureondemand=false in your gradle.properties file or use a Gradle version less than 4.6.
In order to disable configuration on demand in Android Studio it must be configured in the settings for Android Studio not the
gradle.properties file as described above. You can disable this setting by navigating to
Settings - Build, Execution, Deployment - Compiler - Configure on demand
and deselecting the check box.
For bugs, feature requests and questions please use GitHub Issues.
Contributions to any of our repos via pull requests are welcome. We follow the git flow branching model.
Copyright 2018 AEVI International GmbH
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.