| Table of Contents |
|---|
...
| Table of Contents |
|---|
Components List
| Code Block |
|---|
JAVADOC................................................................................................ |
| View file | ||
|---|---|---|
|
| Code Block |
|---|
LIST OF MOST NOTABLE..................................................................................
[ArkosLib]
- doPayment
- doCylic
[Services (callbacks)]
+ cardholderDisplay
+ merchantDisplay
+ cardholderInput
+ merchantInput
+ cardholderChooseApplication
+ cardholderInputZipCode // Persist (Default)
+ store
+ load
+ delete // Security
+ get_pin_block
+ get_ksn // Techno polling
+ poll_techno
+ remove_card // Communication (Default)
+ transmit // Validator (Default)
+ validate_acquirer_response // TMSModule
+ doConfiguration // Retail Module
+ start
+ poll
+ signal
+ respond |
📐 Documentation – Upcoming
Workflow UML;
Merchant App’s State-Machine UML;
Default Stub project;
…
📐 Current Limitations
...
Only supports RapidConnect;
...
Some card types not yet supported by ArkosLib [TODO: add details]
...
Component | Description | Version |
ArkosLib | Arkos Library, in the *.aar format; |
Main contents <ca.amadis.arkoslib>:
ArkosSystem;
IArkosDisplayProvider;
(CardHolder & Merchant Display interface;)IArkosPersistProvider;
(Arkos Configs Persistance)IArkosTechnoPollingProvider;
(Detect Cards, contact, contactless, mag-stripe;)IArkosTransmitProvider;
(Level 3 transmission, i.e.: RapidConnect)IArkosSecurityProvider;
(PIN entry)
olalib
OLA Library, in the *.aar format;
dw-comms
AmadisTlv
*.aar library, provides Utils {TlvTree, BuildConfig, TlvUtils}
📐 Project Structure
| Code Block |
|---|
.
├── AmadisTlv # LIBRARIES
│ ├── AmadisTlv.aar #
│ └── build.gradle #
├── arkoslib #
│ ├── arkoslib.aar #
│ └── build.gradle #
├── dw-comm #
│ ├── build.gradle #
│ └── dw-comm.aar #
├── RetailModule #
│ ├── build.gradle #
│ └── RetailModule.aar ###########
│
├── app # MAIN APP
│ ├── proguard-rules.pro #
│ └── src #
│ └── main[…] ##########
│
├── build.gradle # main gradle.build file
├── gradle […] # gradle-wrapper and so on (auto)
├── gradle.properties
├── gradlew
├── gradlew.bat
├── local.properties # paths to local SDKs
├── olalib
│ ├── build.gradle
│ └── OLA_lib_android.aar
└── settings.gradle # link all libraries for main gradle build |
📐 API Documentation – Available
...
See https://teamamadis.atlassian.net/wiki/spaces/AF/pages/1134002181 | ||
Configuration Module | https://teamamadis.atlassian.net/wiki/spaces/AF/pages/1111031823/Configuration+Module | |
Retail Module | https://teamamadis.atlassian.net/wiki/spaces/AF/pages/1127448759/Retail+Module | |
OLA Module | ||
AmadisTlv | ||
UnifiedConnectionProvider | https://teamamadis.atlassian.net/wiki/spaces/AF/pages/1127448766/Unified+Connection+Provider | |
Amaracq |
Integration steps
Include the Arkoslib (Framework Core) library in an Android project
Override default behavior on service providers as required, or use default implementations when available if the base behavior is sufficient
Include optional libraries to access extended functionality including:
Helpers ( AmadisTLV , …)