Difference between revisions of "IOS API Documentation"

From Cloud9 Payment Processing Gateway Documentation
Jump to: navigation, search
(→‎Download iOS SDK Library)
(→‎Sample Usage)
 
(73 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Template:C9Header|iOS Integration}}
 
{{Template:C9Header|iOS Integration}}
−
[[image:iOS.jpg|thumb|HTTP API Sample Screenshot|link=http://cloud9paymentgateway.com/files/PDC/iOS/]]<br>
+
[[image:iOS.jpg|thumb|Sample Test Application Screenshot|link=http://cloud9paymentgateway.com/files/API/samples/iOS]]<br>
−
==Download iOS SDK Library==
+
=Download =
−
Please use this link to download the library: '''[http://cloud9paymentgateway.com/files/PDC/iOS/ iOS SDK Library]'''
+
'''[http://cloud9paymentgateway.com/files/PDC/iOS/ iOS SDK Library & Sample Application]'''
 +
* <code>iPDCLib.framework</code> is the framework that can be used with your application.
 +
* <code>iPDCApp</code> is the sample app
 +
** See <code>iPDCApp/ViewController.m</code> file for sample usage of the <code>iPDCLib.framework</code>
 +
** In the sample code, the framework is placed under <code>iPDCApp/iPDC.libframework</code> directory
 +
** Always use the latest version of iPDCLib.framework from our web site.
  
−
==Installation and Build ==
+
=JSON Protocol Reference=
−
#Unzip Payment.zip
+
The native iOS Payment Device Controller module facilitates payment operations via JSON Key-Value pairs. '
−
#Copy Payment/ folder to project_root
+
<br>See '''[[JSON API Documentation]]''' for full functionality info.
−
#Open xcode and drag project_root/Payment/ folder to xcode project (select copy if needed)
 
−
#'''target->Build Settings->Other Linker Flags'''<br>Add -Objc, -lc++, -all_load
 
−
#'''target->Build Settings->Enable bitcode'''->No
 
  
−
==Verify Search Paths==
+
=Setup=
−
To avoid the Apple Linker Errors:<br>
+
==Installation==
−
#'''target->Build Settings->Library Search paths'''<br>* Path of the payment library - eg '''$(PROJECT_DIR)/CardTest/Payment'''<br>* Path of the react - eg '''$(PROJECT_DIR)/CardTest/Payment/React'''
+
# Use the API & Sample Download Link above to download the package and unzip it to a local drive.
−
#'''target->Build Phases->Link Binary With Libraries'''<br>Add these files:<br>* Click + -> select libPayment.a (Payment/libPayment.a)<br>* Click + -> select libPaymentPhone.a (Payment/libPaymentPhone.a)<br>* Click + -> select libReact.a (Payment/React/libReact.a)
+
# Add iPDCLib.framework to your project like other normal framework.
−
#'''target->Build Phases->Copy Bundle Resources'''<br>Click + -> select main.jsbundle (Payment/include/main.jsbundle)
 
  
−
==Import==
+
===Bluetooth Instructions(e.g. Ingenico ICMP model)===
−
Import '''Payment.h''' in header file of  '''UIViewController'''<br>
+
# Add "Supported external accessory protocols" to your app's <code>info.plist</code> with value <code>"com.ingenico.easypayemv.spm-transaction"</code> (there is a sample <code>info.plist</code> in the <code>iPDCApp</code>directory)
−
<syntaxhighlight lang="cpp">
+
# Enable background communication. Add "Required background" to your app's info.plist with value "App communicates with an accessory" (there is a sample info.plist in the iPDCAPP.zip)
−
//ViewController.h
 
−
#import "Payment.h"
 
−
</syntaxhighlight>
 
  
−
==Initialization==
+
===IP Based Communication Setup (e.g. Ingenico IPP320 ===
−
To initialize library functions, write below code in the implementation file<br>
+
For Ingenico IPP320, to find the Payment Terminal IP Address, restart it and hit F2 when you see the RBA version.
−
<syntaxhighlight>
 
−
[[Payment sharedMySingleton] initializeReactView:self]
 
  
−
//ViewController.m
+
=Sample JSON Request=
−
- (void)viewDidLoad {
+
<code>{  
−
    [super viewDidLoad];
+
"GMID": "2001003223",
−
    [[Payment sharedMySingleton] initializeReactView:self];
+
"GTID": "GT3010020919",
−
}
+
"GMPW": "03",
−
</syntaxhighlight>
+
"TransType": "Sale",
 +
"Medium": "Credit",
 +
"MainAmt": "100",
 +
"NeedSwipeCard": "Y"
 +
}</code>
  
−
==Usage==
+
=API Usage=
−
===Request===
+
==Basic Flow==
−
<syntaxhighlight>
+
See '''iPDCApp/ViewController.m''' file and [[JSON API Documentation]] for reference
−
NSMutableDictionary *data = [@{
+
;1. Initialize
−
                            @"apiCall":@{
+
:Call <code>initWithDelegate</code>
−
                              @"url": @"https://testlink.c9pg.com:5551/hj",
+
;2. Set general parameters
−
                              @"method": @"POST",
+
:Call <code>setProperties</code>.
−
                              @"data": @{
+
;3. Process transactions
−
                                  @"GMID": @"1234",
+
:Call <code>postTransactionToUrl:request:withTimeout</code> to process transactions. Repeat as many times as necessary.
−
                                  @"GTID": @"1234",
+
;4. Get transaction response
−
                                  @"GWPW": @"1234",
+
:<code>TransDataReceived</code> function will be called on payment engine response
−
                                  @"MainAmt": @"123",
 
−
                                                 
 
−
                            }
 
−
                    }
 
−
                  } mutableCopy];
 
−
[[Payment sharedMySingleton] send:data];
 
−
</syntaxhighlight>
 
  
−
===Response===
+
;5.    (Optional) to get track data, use <code>performAction</code> request
−
Response of api call will be received at '''onResponseCallback'''<br>
+
:<code>ActionDataReceived</code> function will be called in response to additional info request via <code>performAction</code> call (e.g. Track Data)
−
Response object contains request and response Json.<br>
 
−
<syntaxhighlight>
 
−
//ViewController.m
 
−
- (void)onResponseCallback:(id)response {
 
−
    NSLog(@"%@", response);
 
−
    NSString *string = [NSString stringWithFormat:@"%@", [response objectForKey:@"responseJson"]];
 
−
    NSLog(@"%@", string);
 
−
}
 
−
</syntaxhighlight>
 
  
 +
==API Introduction==
 +
See '''iPDCApp/ViewController.m''' file and [[JSON API Documentation]] for reference.
  
 +
Class iPDCManager is the main interface.
 +
;1. Protocol <code>IPDCManagerNotify</code> includes four events:
 +
:-(void) deviceConnected; ==>triggered when pinpad connected
 +
:-(void) deviceDisconnected;==>triggered when pinpad disconnected
 +
:-(void) TransDataReceived:(NSData*)data; ==>callback function for when postTransactionToUrl api is called. Param data is the transaction return data with JSON format. This format detail can be found in our [[JSON API Documentation]].
 +
:-(void) TrackDataReceived:(NSData*)data; ==>callback function for when readTrackData api is called. Param data is the track2 data with JSON format.This format's detail can be found in our [[JSON API Documentation]].
 +
;2. <code>initWithDelegate</code>
 +
: Instantiate the '''iPDCManager''' class and set the '''IPDCManagerNotify''' delegate.
 +
;3. <code>setProperties</code>
 +
: Set the configurations in key-value format.
 +
:''Valid Keys''
 +
:<code>Prop_RushMode</code>:  enable rush mode or not,default value is "false",valid value is "false" and "true"
 +
:<code>Prop_UploadUrl</code>:  set where to upload the rush mode transactions ,NO default value.
 +
:<code>Prop_CheckInterval</code>: interval for checking rush mode transactions.default value is 60
 +
:<code>Prop_FailedThreshold</code>: the max count of trying transactions before enter the rush mode,default value is 3
 +
:<code>Prop_QuickChip</code>: enable quickchip,default value is "true",valid value is "false" and "true"
 +
:<code>Prop_PinpadIP</code>: Pinpad's IP address for ethernet interface, NO default value.
 +
:<code>Prop_PinpadPort</code>: Pinpad's port number for ethernet interface, default value is 12000
 +
:<code>Prop_PinpadInterface</code>: set which interface to use. valid value is "BT" and ETHERNET", '''NO default value,need to be set explicitly.'''
 +
:'''NOTE:'''
 +
* &rarr; <code>Prop_PinpadInterface</code> key must be explicitly set. This must be called in the main thread only once.
 +
* &rarr; Search for <code>bSupportIPP320</code> variable in sample code to learn how to use Bluetooth or Ethernet for connecting to the payment terminal (ICMP is bluetooth, IPP320 is Ethernet.
 +
* &rarr; '''For Bluetooth only:''' add "Supported external accessory protocols" to your app's <code>info.plist</code> with value <code>"com.ingenico.easypayemv.spm-transaction"</code> (there is a sample <code>info.plist</code> in the <code>iPDCApp</code>directory)
 +
 +
 +
;4. <code>postTransactionToUrl:request:withTimeout</code>
 +
:Process the transaction request. This will send the request to url via https protocol unless it is Store & Forward (Rush Mode). The request detail can be found in our [[JSON API Documentation]].
 +
;* 4a <code>TransDataReceived</code> function
 +
: This function will receive JSON response from the POST above.  For instance <code>ResponseCode</code>,<code>AuthCode</code>, <code>ErrorText</code>, etc Use [[JSON API Documentation]] for details.
 +
;5. <code>performAction</code> request.
 +
: Use parameter {"TransType":"ReadTrackData"} to get track2 data for swipe id cards, in-house gift cards, etc.
 +
;* 5a<code>ActionDataReceived</code> function
 +
: This function will be called with return data. You can use JSON parameters, such as <code>Track2</code> to retrieve useful data.
 +
 +
=iPassthruManager (DEPRECATED)=
 +
Passthru manager is an older version of Payment Device Controller Manager without Store & Forward. It is maintained for backward compatibility.
 +
Click on the following link for [[API_iPassThruManager (DEPRECATED)|information on iPassthruManager]]
  
  
 
{{Template:C9Footer|Integration}}
 
{{Template:C9Footer|Integration}}

Latest revision as of 13:43, 2 November 2018




Cloud9 Payment Gateway Documentation. This site can also be reached at http://docs.cloud9paymentgateway.com

Sample Test Application Screenshot

Download

iOS SDK Library & Sample Application

  • iPDCLib.framework is the framework that can be used with your application.
  • iPDCApp is the sample app
    • See iPDCApp/ViewController.m file for sample usage of the iPDCLib.framework
    • In the sample code, the framework is placed under iPDCApp/iPDC.libframework directory
    • Always use the latest version of iPDCLib.framework from our web site.

JSON Protocol Reference

The native iOS Payment Device Controller module facilitates payment operations via JSON Key-Value pairs. '
See JSON API Documentation for full functionality info.

Setup

Installation

  1. Use the API & Sample Download Link above to download the package and unzip it to a local drive.
  2. Add iPDCLib.framework to your project like other normal framework.

Bluetooth Instructions(e.g. Ingenico ICMP model)

  1. Add "Supported external accessory protocols" to your app's info.plist with value "com.ingenico.easypayemv.spm-transaction" (there is a sample info.plist in the iPDCAppdirectory)
  2. Enable background communication. Add "Required background" to your app's info.plist with value "App communicates with an accessory" (there is a sample info.plist in the iPDCAPP.zip)

IP Based Communication Setup (e.g. Ingenico IPP320

For Ingenico IPP320, to find the Payment Terminal IP Address, restart it and hit F2 when you see the RBA version.

Sample JSON Request

{ 

"GMID": "2001003223",
"GTID": "GT3010020919",
"GMPW": "03",
"TransType": "Sale",
"Medium": "Credit",
"MainAmt": "100",
"NeedSwipeCard": "Y"
}

API Usage

Basic Flow

See iPDCApp/ViewController.m file and JSON API Documentation for reference

1. Initialize
Call initWithDelegate
2. Set general parameters
Call setProperties.
3. Process transactions
Call postTransactionToUrl:request:withTimeout to process transactions. Repeat as many times as necessary.
4. Get transaction response
TransDataReceived function will be called on payment engine response
5. (Optional) to get track data, use performAction request
ActionDataReceived function will be called in response to additional info request via performAction call (e.g. Track Data)

API Introduction

See iPDCApp/ViewController.m file and JSON API Documentation for reference.

Class iPDCManager is the main interface.

1. Protocol IPDCManagerNotify includes four events
-(void) deviceConnected; ==>triggered when pinpad connected
-(void) deviceDisconnected;==>triggered when pinpad disconnected
-(void) TransDataReceived:(NSData*)data; ==>callback function for when postTransactionToUrl api is called. Param data is the transaction return data with JSON format. This format detail can be found in our JSON API Documentation.
-(void) TrackDataReceived:(NSData*)data; ==>callback function for when readTrackData api is called. Param data is the track2 data with JSON format.This format's detail can be found in our JSON API Documentation.
2. initWithDelegate
Instantiate the iPDCManager class and set the IPDCManagerNotify delegate.
3. setProperties
Set the configurations in key-value format.
Valid Keys
Prop_RushMode: enable rush mode or not,default value is "false",valid value is "false" and "true"
Prop_UploadUrl: set where to upload the rush mode transactions ,NO default value.
Prop_CheckInterval: interval for checking rush mode transactions.default value is 60
Prop_FailedThreshold: the max count of trying transactions before enter the rush mode,default value is 3
Prop_QuickChip: enable quickchip,default value is "true",valid value is "false" and "true"
Prop_PinpadIP: Pinpad's IP address for ethernet interface, NO default value.
Prop_PinpadPort: Pinpad's port number for ethernet interface, default value is 12000
Prop_PinpadInterface: set which interface to use. valid value is "BT" and ETHERNET", NO default value,need to be set explicitly.
NOTE:
  • → Prop_PinpadInterface key must be explicitly set. This must be called in the main thread only once.
  • → Search for bSupportIPP320 variable in sample code to learn how to use Bluetooth or Ethernet for connecting to the payment terminal (ICMP is bluetooth, IPP320 is Ethernet.
  • → For Bluetooth only: add "Supported external accessory protocols" to your app's info.plist with value "com.ingenico.easypayemv.spm-transaction" (there is a sample info.plist in the iPDCAppdirectory)


4. postTransactionToUrl:request:withTimeout
Process the transaction request. This will send the request to url via https protocol unless it is Store & Forward (Rush Mode). The request detail can be found in our JSON API Documentation.
  • 4a TransDataReceived function
This function will receive JSON response from the POST above. For instance ResponseCode,AuthCode, ErrorText, etc Use JSON API Documentation for details.
5. performAction request.
Use parameter {"TransType":"ReadTrackData"} to get track2 data for swipe id cards, in-house gift cards, etc.
  • 5aActionDataReceived function
This function will be called with return data. You can use JSON parameters, such as Track2 to retrieve useful data.

iPassthruManager (DEPRECATED)

Passthru manager is an older version of Payment Device Controller Manager without Store & Forward. It is maintained for backward compatibility. Click on the following link for information on iPassthruManager





From the makers of Cloud9 Payment Processing Gateway and Creditline Credit Card Processing Software

Retrieved from "http://cloud9paymentgateway.com/w/index.php?title=IOS_API_Documentation&oldid=782"