Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
getting_started:android:1.4.10_-_1.5.2 [2019/11/01 11:27]
branko
— (current)
Line 1: Line 1:
-====== Getting Started with Android ====== 
  
-~~TOC~~ 
- 
-\\ 
-The %BRANDNAME SDK is a library for communicating with the %GATEWAYNAME Payment Gateway. It wraps a set of interfaces and logic that  connects the **Payment Gateway**, the **Card Reader Devices** and the client'​s side security. 
- 
-This page presents the basic steps to build your own solution using our SDK.  
-\\ 
- 
-<WRAP round box 100%> 
-**NEW DOCUMENTATION VERSION** 
- 
-This guide is applicable from SDK Version **__1.4.10__** and **__1.5.2__**. For older versions, use the menu navigation on the left side of this page. 
-</​WRAP>​ 
- 
-\\ 
-===== Step 01 - Download The Components ===== 
- 
-You can find our current supported version at the **[[:​sdk_versions:​android|Download SDK Versions]]** page. 
- 
-<WRAP round box 100%> 
-**REMEMBER TO SELECT YOUR PLUGINS** 
- 
-Select the **Plugins** you'll be using in your application. That depends on the **Card Reader Devices** you are going to use. 
-If you don't want to start from scratch, also download the **Sample App** provided to the version. This App will give you a good start point for you POS project. 
- 
-</​WRAP>​ 
- 
-\\ 
-===== Step 02 - Create Your Project and Install the SDK ===== 
- 
-<WRAP round box 100%> 
-**REQUIREMENTS** 
- 
-This platform and version targets the Android version 4.4. 
-</​WRAP>​ 
- 
-The installation of the SDK is as easy as adding the %BRANDNAME SDK to your project. For that you need: 
- 
-  * **I)** ​ Copy the **%coreSDKLibNameANDROID** to the application folder and add it as a dependency. 
-  * **II)** ​ Go to the AndroidManifest.xml and set these permissions. 
- 
-<code xml> 
-<​uses-permission android:​name="​android.permission.INTERNET"/>​ 
-<​uses-permission android:​name="​android.permission.ACCESS_NETWORK_STATE"/>​ 
-</​code>​ 
- 
-  * **III)** ​ Copy payconfig.xml into your project'​s res/values directory. 
- 
-The **payconfig.xml** file contains URLs used to access the servers, so don't forget to add it to your project, or the communication is not going to happpen. 
- 
-If you want to start with the Sample App, just follow the steps of creating a new project from an existing source. Each IDE works in a different way, but when creating a new project, most offer an option to create based on an existing project or based on source files where you just have to point to a repository. This repository would be the decompressed folder of the Sample App in the last step of the previous section. 
- 
-<WRAP round box 100%> 
-**GSON DEPENDENCY** 
- 
-Please, note that the SDK requires a GSON dependency to be added to your project separately. 
-If you are using gradlle, add the folloing line to the **dependencies** node: 
- 
-<code java> 
-dependencies { 
-    implementation '​com.google.code.gson:​gson:​2.8.2'​ 
-} 
-</​code>​ 
-</​WRAP>​ 
- 
-===== Step 03 - Implement the CoreAPIListener ===== 
- 
-The application needs to implement the Core API Listener (CoreAPIListener) to interact with the SDK.  
- 
-On Android this makes the most sense in the MainActivity,​ as follows: 
- 
-<​html>​ 
-<div class="​code_block">​ 
-<div class="​nav">​ 
-<a data-code="​java">​Android</​a>​ 
-</​div>​ 
-<ul> 
-<li data-code="​java">​ 
-</​html>​ 
-<code java> 
-public class MainActivity implements CoreAPIListener{ 
-</​code>​ 
-<​html>​ 
-</li> 
-</ul> 
-</​div>​ 
-</​html>​ 
- 
-\\ 
- 
-For further reading on CoreAPIListener,​ consult the **[[sdk_documentation:​android:​coreapilistener|Core API Listener]]** page at the **[[sdk_documentation:​android|SDK Documentation]]** section. 
- 
-\\ 
-The **CoreAPIListener** interface contains all the methods used for interactions. 
- 
-If your application contains multiple activities, instead of each activity conforming CoreAPIListener interface and implementing all of its methods, you can use the following listeners, which are suited for your activities. 
- 
- 
-<​code>​ 
-CoreAPIDeviceListener 
-CoreAPIReportingListener 
-CoreAPISaleListener 
-CoreAPISecureCardListener 
-CoreAPISettingsListener 
-CoreAPIRefundListener 
-CoreAPIReversalListener 
-CoreAPIUpdateListener 
-CoreAPIErrorListener 
-CoreAPIMessageListener 
-</​code>​ 
- 
-\\ 
-Then, register the listeners implementing the interfaces above: 
- 
-<​html>​ 
-<div class="​code_block">​ 
-<div class="​nav">​ 
-<a data-code="​java">​Android</​a>​ 
-</​div>​ 
-<ul> 
-<li data-code="​java">​ 
-</​html>​ 
-<code java> 
-AndroidTerminal.getInstance().registerCoreAPIDeviceListener(this);​ 
-</​code>​ 
-<​html>​ 
-</li> 
-</ul> 
-</​div>​ 
-</​html>​ 
- 
-\\ 
-===== Step 04 - Initialise the Terminal ===== 
- 
-  * **I)** ​  You should use the Terminal (singleton instance) provided by the SDK. 
- 
-Where ''​%%this%%''​ is an object that implements the CoreAPIListener (i.e. this code snippet is done inside the MainActivity) 
- 
-<​html>​ 
-<div class="​code_block">​ 
-<div class="​nav">​ 
-<a data-code="​java">​Android</​a>​ 
-</​div>​ 
-<ul> 
-<li data-code="​java">​ 
-</​html>​ 
-<code java> 
-AndroidTerminal.getInstance().initialize(this);​ 
-</​code>​ 
-<​html>​ 
-</li> 
-</ul> 
-</​div>​ 
-</​html>​ 
- 
-\\ 
-The terminal can also be initialized without CoreAPIListener 
- 
-<​html>​ 
-<div class="​code_block">​ 
-<div class="​nav">​ 
-<a data-code="​java">​Android</​a>​ 
-</​div>​ 
-<ul> 
-<li data-code="​java">​ 
-</​html>​ 
-<code java> 
-AndroidTerminal.getInstance().initialize();​ 
-</​code>​ 
-<​html>​ 
-</li> 
-</ul> 
-</​div>​ 
-</​html>​ 
- 
-\\ 
-  * **II)** ​ Now, set the Terminal Mode, (TEST, DEV or LIVE), depending on your needs. 
- 
-This is an easy one as well.  
-All you have to do is to set the terminal mode to the right type. 
- 
-The **Test Mode** should be used for development - It's going to make your app to use the gatewayTestUrl defined in payconfig.xml when communicating with the server. 
-Before initiate your Terminal, enable the Test Mode: 
- 
-<​html>​ 
-<div class="​code_block">​ 
-<div class="​nav">​ 
-<a data-code="​java">​Android</​a>​ 
-</​div>​ 
-<ul> 
-<li data-code="​java">​ 
-</​html>​ 
-<code java> 
-AndroidTerminal.getInstance().setMode(CoreMode.TEST);​ 
-</​code>​ 
-<​html>​ 
-</li> 
-</ul> 
-</​div>​ 
-</​html>​ 
- 
-\\ 
-After finishing the development of your app, don't forget to change the mode again to go Live (**Live Mode**, that points to gatewayLiveUrl defined in payconfig.xml file). 
- 
-<​html>​ 
-<div class="​code_block">​ 
-<div class="​nav">​ 
-<a data-code="​java">​Android</​a>​ 
-</​div>​ 
-<ul> 
-<li data-code="​java">​ 
-</​html>​ 
-<code java> 
-AndroidTerminal.getInstance().setMode(CoreMode.LIVE);​ 
-</​code>​ 
-<​html>​ 
-</li> 
-</ul> 
-</​div>​ 
-</​html>​ 
- 
-\\ 
-You still have one option: the **Dev Mode**. 
- 
-<​html>​ 
-<div class="​code_block">​ 
-<div class="​nav">​ 
-<a data-code="​java">​Android</​a>​ 
-</​div>​ 
-<ul> 
-<li data-code="​java">​ 
-</​html>​ 
-<code java> 
-AndroidTerminal.getInstance().setMode(CoreMode.DEV);​ 
-</​code>​ 
-<​html>​ 
-</li> 
-</ul> 
-</​div>​ 
-</​html>​ 
- 
-\\ 
-The Dev Mode is used to point to gatewayDevUrl defined in payconfig.xml file. The Dev Host usually contains unreleased features. 
- 
-\\ 
-  * **III)** ​ Now, set the Terminal Log Level (NONE, ERROR, TEST or FULL), depending on your needs. 
- 
-This is also an easy one. All you have to do is to set the terminal log level to the right type. 
- 
-  * **LEVEL_FULL**:​ This level will allow SDK to print all logs into the log file and the console. Level FULL will be default level for TEST or DEV mode. 
-  * **LEVEL_TEST**:​ This level will allow SDK to print logs which do no contain any sensitive data e.g. requests and responses to the server, tlv strings, emv tags, encrypted data, etc. Level Info will be default level for LIVE mode. 
-  * **LEVEL_ERROR**This level will allow SDK to print only errors. Any error that occurs in the SDK, any error that the server returns, any error that the device returns. No other logs such as events, method calls will be printed. 
-  * **LEVEL_NONE**:​ This level will disable logs in the SDK. 
- 
-<​html>​ 
-<div class="​code_block">​ 
-<div class="​nav">​ 
-<a data-code="​java">​Android</​a>​ 
-</​div>​ 
-<ul> 
-<li data-code="​java">​ 
-</​html>​ 
-<code java> 
-AndroidTerminal.getInstance().setLogLevel(LogLevel.LEVEL_FULL);​ 
-</​code>​ 
-<​html>​ 
-</li> 
-</ul> 
-</​div>​ 
-</​html>​ 
- 
-\\ 
-  * **IV)** Once the Terminal is created, initialize it. 
- 
-{gateway=docs.gochipnow.com}{gateway=gochip.payconexplus.com}{gateway=corepay.anywherecommerce.com}{gateway=docs.nuvei.com}{gateway=testdocs.gochipnow.com}{gateway=testgochippayconexpluscom.worldnettps.com}{gateway=testcorepayanywherecommercecom.worldnettps.com}{gateway=testdocsnuveicom.worldnettps.com} 
- 
-The arguments are the terminal ID and secret. These are credentials required to use a Terminal using the SDK. 
- 
-<​html>​ 
-<div class="​code_block">​ 
-<div class="​nav">​ 
-<a data-code="​java">​Android</​a>​ 
-</​div>​ 
-<ul> 
-<li data-code="​java">​ 
-</​html>​ 
-<code java> 
-AndroidTerminal.getInstance().initWithConfiguration(MainActivity.this,​ TERMINAL_ID,​ SECRET); 
-</​code>​ 
-<​html>​ 
-</li> 
-</ul> 
-</​div>​ 
-</​html>​ 
- 
-{/gateway} 
- 
-\\ 
-{gateway=bluechip.payconex.net}{gateway=testbluechippayconexnet.worldnettps.com} 
- 
-The arguments are the account ID and API access key. These are credentials required to use a Terminal using the SDK. 
- 
-<​html>​ 
-<div class="​code_block">​ 
-<div class="​nav">​ 
-<a data-code="​java">​Android</​a>​ 
-</​div>​ 
-<ul> 
-<li data-code="​java">​ 
-</​html>​ 
-<code java> 
-AndroidTerminal.getInstance().initWithConfiguration(MainActivity.this,​ ACCOUNT_ID, API_ACCESS_KEY);​ 
-</​code>​ 
-<​html>​ 
-</li> 
-</ul> 
-</​div>​ 
-</​html>​ 
- 
-{/gateway} 
- 
-\\ 
-===== Step 05 - Handle the Initialisation Response ===== 
- 
-Once the Terminal is initialized,​ it is necessary to handle all response types. 
- 
-The Terminal initialization attempts to connect to the server and the response must then be verified. The SDK does that with the methods: **onError** and **onSettingsRetrieved**. 
- 
-==== Successful Response ==== 
- 
-If your initialization worked properly, without problems, your application is going to receive the response at the **onSettingsRetrieved** method. 
- 
-<​html>​ 
-<div class="​code_block">​ 
-<div class="​nav">​ 
-<a data-code="​java">​Android</​a>​ 
-</​div>​ 
-<ul> 
-<li data-code="​java">​ 
-</​html>​ 
-<code java> 
-@Override 
-public void onSettingsRetrieved(CoreSettings settings) { 
- // ... 
-} 
-</​code>​ 
-<​html>​ 
-</li> 
-</ul> 
-</​div>​ 
-</​html>​ 
- 
-\\ 
-You need to use the argument returned to extract the response. 
- 
-==== Unsuccessful Response ==== 
- 
-If anything went wrong with the initialization,​ your application is going to receive an error at the **onError** method. 
- 
-<​html>​ 
-<div class="​code_block">​ 
-<div class="​nav">​ 
-<a data-code="​java">​Android</​a>​ 
-</​div>​ 
-<ul> 
-<li data-code="​java">​ 
-</​html>​ 
-<code java> 
-@Override 
-public void onError(CoreError error, String message) { 
- Log.d(TAG, "​onError"​);​ 
- // ... treatment for initialization error 
-} 
-</​code>​ 
-<​html>​ 
-</li> 
-</ul> 
-</​div>​ 
-</​html>​ 
- 
-\\ 
-In the event of an error, your application can show the error text, a generic message or execute a particular action, based on the error. 
- 
-\\ 
-===== Step 06 - Install Your Plugins ===== 
- 
-  * **I)** ​  Copy the appropriate plugin(s) to your project folder. 
-  * **II)** ​ Add the plugin libraries as dependencies for the project. 
-  * **III)** Additional Frameworks Required per Device, in case you are using any of the plugins. 
- 
-  * **BBPosDevice** 
- 
-<code xml> 
-<​uses-permission android:​name="​android.permission.BLUETOOTH"/>​ 
-<​uses-permission android:​name="​android.permission.BLUETOOTH_ADMIN"/>​ 
-<​uses-permission android:​name="​android.permission.RECORD_AUDIO"/>​ 
-<​uses-permission android:​name="​android.permission.MODIFY_AUDIO_SETTINGS"/>​ 
-<​uses-permission android:​name="​android.permission.ACCESS_COARSE_LOCATION"/>​ 
-</​code>​ 
- 
-  * **Rambler** 
- 
-<code xml> 
-<​uses-permission android:​name="​android.permission.RECORD_AUDIO"/> ​ 
-<​uses-permission android:​name="​android.permission.MODIFY_AUDIO_SETTINGS"/>​ 
-</​code>​ 
- 
-===== Step 07 - Initialize the Device ===== 
- 
-Now we can initialize the device using our Terminal. 
- 
-The **first** argument is a DeviceEnum corresponding to the device your application is going to use. The **second** argument is a connection type. The **third** argument is optional for initializing a bluetooth device with a pre stored bluetooth address. 
- 
-<​html>​ <div class="​code_block">​ <div class="​nav">​ <a data-code="​java">​Android</​a>​ </​div>​ <ul> <li data-code="​java">​ </​html>​ 
-<code java> 
-AndroidTerminal.getInstance().initDevice(DeviceEnum.BBPosDevice,​ DeviceConnectionType.BLUETOOTH,​ null); 
-</​code>​ 
-<​html>​ </li> </ul> </​div>​ </​html>​ 
- 
-{gateway=testdocs.gochipnow.com}{gateway=docs.gochipnow.com} 
- 
-An additional option would be to configure tips to be used with your Card Reader Device. 
- 
-To do that, you only need to add the //​HashMap<​ String, Object > data// argument (presented in the example above as null) with the following elements. 
- 
-<​html>​ <div class="​code_block">​ <div class="​nav">​ <a data-code="​java">​Android</​a>​ </​div>​ <ul> <li data-code="​java">​ </​html>​ 
-<code java> 
-data.put("​emvType",​ CoreEmvType.QUICK_CHIP);​ 
-data.put("​configureOnlyAtStart",​ true); 
-data.put("​enableTips",​ true); 
-data.put("​tipPreDefinedAmount",​ 12); 
-</​code>​ 
-<​html>​ </li> </ul> </​div>​ </​html>​ 
-\\ 
- 
-Remember that you need to configure the tips will in your Self-Care account. With the configuration above you can define the values which can be used for both tips by AMOUNT and tips by PERCENTAGE. 
- 
-<WRAP round box 100%> 
-**TIP IN YOUR TERMINAL ACCOUNT** 
- 
-Login to your terminal, select SETTINGS then TERMINAL. Then, decide if you are going to allow tips and set the Terminal Tips values. 
- 
-For example if you have set up 5$, 10$, 15$, 5%, 10% and 15% as your AMOUNT and PERCENTAGE tips, and set the above as 
-<code java> 
-data.put("​tipPreDefinedAmount",​ 12); 
-</​code>​ 
- 
-In this scenario, the following rules will apply: 
- 
-**1)** If the transaction amount is LESS than "​tipPreDefinedAmount",​ the device will display tips by AMOUNT (i.e. any transaction here lower than 12$ the user will be prompted with 5$, 10$ OR 15$ OR OTHER to be added to the total).\\ 
-**2)** If the transaction amount is MORE than "​tipPreDefinedAmount",​ the device will display tips by PERCENTAGE (i.e. any transaction here higher than 12$ the user will be prompted with 5%, 10% OR 15% OR OTHER added to total). 
-</​WRAP>​ 
-\\ 
-The predefined tip amount can be easily edited in the above code to the amount that suits your needs (ie): 
-<​html>​ <div class="​code_block">​ <div class="​nav">​ <a data-code="​java">​Android</​a>​ </​div>​ <ul> <li data-code="​java">​ </​html>​ 
-<code java> 
-data.put("​tipPreDefinedAmount",​ 25); 
-</​code>​ 
-<​html>​ </li> </ul> </​div>​ </​html>​ 
-\\ 
-This will change the above rules to use 25$ to decide if AMOUNT or PERCENTAGE tips will be used. 
- 
-Custom amounts will always be available as a tip. They will be displayed as OTHER on the device tip page. The amount entered will be added to the total as an AMOUNT. 
- 
-<WRAP round box 100%> 
-**TIP SUPPORT FOR YOUR DEVICE** 
- 
-Verify with our integration team if this option is already available for the Device Plugin you intend to use. 
-</​WRAP>​ 
-{/gateway} 
-\\ 
- 
-For devices connecting via Bluetooth, onSelectBTDevice method will return list of available devices. It will be possible to choose the device from the list to connect to it. 
- 
-<​html>​ <div class="​code_block">​ <div class="​nav">​ <a data-code="​java">​Android</​a>​ </​div>​ <ul> <li data-code="​java">​ </​html>​ 
-<code java> 
-@Override 
-public void onSelectBTDevice(ArrayList<​Object>​ type) { 
-    // ... 
-} 
-</​code>​ 
-<​html>​ </li> </ul> </​div>​ </​html>​ 
- 
-\\ 
-Call selectBTDevice (to connect to the device) to pass the position of the device from the list. The argument passed is the position of the device selected by the user from the list returned by the **onSelectBTDevice** above. 
- 
-<​html>​ <div class="​code_block">​ <div class="​nav">​ <a data-code="​java">​Android</​a>​ </​div>​ <ul> <li data-code="​java">​ </​html>​ 
-<code java> 
-AndroidTerminal.getInstance().selectBTDevice(0);​ 
-</​code>​ 
-<​html>​ </li> </ul> </​div>​ </​html>​ 
- 
-\\ 
-===== Step 08 - Implement Your Features ===== 
- 
-For further reading on how to execute transactions (Sale, Refund, Report, etc.) visit the section **[[transaction_flows:​default_mode|Default Mode]]** and explore the options. ​ 
- 
-Also, in case you are interested in working with different flow configurations,​ like a offline terminal, visit **[[transaction_flows:​offline_mode|Offline Mode]]**, or with unattended terminals, visit **[[transaction_flows:​polling_mode|Polling Mode]]**. More options are also available in **[[:​transaction_flows|Transaction Flows]]**. 
- 
-The following pages will assist you in understanding and implementing your features: 
- 
-  * **[[secure_card:​|Secure Cards]]**: if you want to store your customers'​ details in a safe way using tokens. 
-  * **[[sdk_documentation:​|SDK Documentation Reference]]**:​ documentation reference of the SDK platform code. 
-  * **[[understanding_the_sdk:​|Understanding the SDK]]**: a little more about how the SDK works. 
-    
-If you have questions, please talk to us using the **[[:​contact|Contact]]** link at the top (right side) of this page. We would love to help!