-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Version 3.1: Deployment target raised to iOS 9
* [CHANGED] If you integrate the SDK manually, please link to the ExternalAccessory framework * [UPDATE] Deployment target raised to iOS 9.0 * [CHANGED] The login mask does not show the "Reveal password" button anymore * [ADDED] SumUp Air Register support * [IMPROVEMENT] Dedicated error code for currency mismatches – please refer to our README for hints regarding correct currency handling * [IMPROVEMENT] Populate NSLocalizedDescriptionKey in SDK errors – you can still access NSUnderlyingErrorKey for more details regarding the underlying error * [ADDED] New currency code constant (CLP) and new languages (es-CL, et)
- Loading branch information
Showing
74 changed files
with
973 additions
and
114 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # SumUp iOS Register SDK Changelog | ||
|
|
||
| ## Version 3.1 | ||
|
|
||
| * [ADDED] SumUp Air Register support | ||
|
|
||
| Sample application: | ||
|
|
||
| * [ADDED] SumUp Air Register support |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| # SumUp mPOS SDK: Air Register Support | ||
|
|
||
| The following information is only relevant if you want to support the SumUp | ||
| Air Register device. For general setup instructions, please refer to our main | ||
| [README](../README.md). | ||
|
|
||
| ### Table of Contents | ||
|
|
||
| * [Installation](#installation) | ||
| * [External Accessory Protocols](#external-accessory-protocols) | ||
| * [MFi Program Authorization](#mfi-program-authorization) | ||
| * [Getting started](#getting-started) | ||
| * [Register SDK](#register-sdk) | ||
| * [Changelog](#changelog) | ||
|
|
||
| ## Installation | ||
|
|
||
| ### External Accessory Protocols | ||
|
|
||
| After [integrating the SumUp SDK](../README.md#installation), please perform | ||
| this step, regardless of your chosen integration option: | ||
|
|
||
| 1. Add the following `UISupportedExternalAccessoryProtocols` to your app's | ||
| [Info.plist](../SampleApp/SumUpSDKSampleApp/SumUpSDKSampleApp-Info.plist) file: | ||
|
|
||
| com.sumup.control | ||
| com.sumup.printing | ||
| com.sumup.air_data | ||
|
|
||
| > You can add these protocols to the Swift sample app for a working register | ||
| demo screen. | ||
|
|
||
| ### MFi Program Authorization | ||
|
|
||
| When your app communicates with the SumUp Air Register, which is an approved | ||
| [MFi](https://developer.apple.com/programs/mfi/) device, Apple requires your application to be registered before | ||
| submission to the App Store. | ||
| This registration process officially associates your app with SumUp Air Register, | ||
| and can only be performed by SumUp. | ||
| Once your application has been registered, future app versions will not require | ||
| additional registrations. | ||
| Please get in touch with [email protected] providing your bundle identifier | ||
| and team ID before submission. | ||
|
|
||
| > This step is only required to publish your app on the App Store. For Ad-Hoc builds | ||
| and Enterprise Distribution this is not necessary. | ||
|
|
||
| ## Getting started | ||
|
|
||
| Before accessing `[SMPSumUpRegisterSDK sharedInstance]`, call `[SMPSumUpRegisterSDK registerIsSupported]` | ||
| to verify that you have set up the register SDK correctly. | ||
|
|
||
| ## Register SDK | ||
|
|
||
| The SumUp Air Register is automatically used as the preferred card terminal while it is | ||
| connected. To use the integrated printer and query its current status, use the | ||
| `SumupRegisterSDK` class. Please make sure that all | ||
| `UISupportedExternalAccessoryProtocols` are included in your apps | ||
| [Info.plist](../SampleApp/SumUpSDKSampleApp/SumUpSDKSampleApp-Info.plist). | ||
|
|
||
| ```objc | ||
| [[SMPSumUpRegisterSDK sharedInstance] setDelegate:self]; | ||
| [[SMPSumUpRegisterSDK sharedInstance] startListeningForRegister]; | ||
|
|
||
| - (void)registerDidConnect:(SMPRegisterSDKStatus *)deviceStatus { | ||
| [[SMPSumUpRegisterSDK sharedInstance] printEscPos:@"Device is conntected"]; | ||
| } | ||
|
|
||
| ``` | ||
|
|
||
| > The register-specific APIs are available without login. | ||
| ## Changelog | ||
|
|
||
| [SumUp Air Register SDK Changelog](CHANGELOG.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,7 +3,7 @@ | |
| [](#prerequisites) | ||
| [](https://sumup.com) | ||
| []() | ||
| [](CHANGELOG.md) | ||
| [](CHANGELOG.md) | ||
| [](LICENSE) | ||
| []() | ||
|
|
||
|
|
@@ -25,9 +25,9 @@ For more information, please refer to SumUp's | |
|
|
||
| ### Prerequisites | ||
| 1. Registered for a merchant account via SumUp's [country websites](https://sumup.com/) (or received a test account). | ||
| 2. Received SumUp card terminal: Air, Air Lite, PIN+ terminal or Chip & Signature reader. | ||
| 2. Received SumUp card terminal: Air, Air Lite, PIN+ terminal, Chip & Signature reader, or SumUp Air Register. | ||
| 3. Requested an Affiliate (Access) Key via [SumUp Dashboard](https://me.sumup.com/developers) for Developers. | ||
| 4. Deployment Target iOS 8.0 or later. | ||
| 4. Deployment Target iOS 9.0 or later. | ||
| 5. Xcode 9 and iOS SDK 11 or later. | ||
| 6. iPhone, iPad or iPod touch. | ||
|
|
||
|
|
@@ -50,6 +50,9 @@ For more information, please refer to SumUp's | |
|
|
||
| ## Installation | ||
|
|
||
| If you want to support the SumUp Air Register, please also read our additional | ||
| [Air Register setup guide](AirRegister/README.md). | ||
|
|
||
| ### Manual Integration | ||
|
|
||
| The SumUp SDK is provided as an embedded framework `SumUpSDK.embeddedframework` | ||
|
|
@@ -62,6 +65,7 @@ images and localizations. Please follow the steps below to prepare your project: | |
|
|
||
| Accelerate | ||
| AVFoundation | ||
| ExternalAccessory | ||
| MapKit | ||
|
|
||
| 4. Add `-ObjC` to "Other Linker Flags" if not yet included. | ||
|
|
@@ -71,11 +75,10 @@ images and localizations. Please follow the steps below to prepare your project: | |
|
|
||
| SumUpSDK.embeddedframework/Resources/SMPSharedResources.bundle | ||
|
|
||
|
|
||
| > Note: | ||
| > Note: | ||
| > You can use the [sample app](SampleApp/SumUpSDKSampleApp) | ||
| > that is provided with the SumUp SDK as a reference project. | ||
| > The Xcode project contains sample apps written in Objective-C and Swift. | ||
| > The Xcode project contains sample apps written in Objective-C and Swift. | ||
| > In your debug setup you can also call `+[SMPSumUpSDK testSDKIntegration]`. | ||
| > It will run various checks and print its findings to the console. | ||
| > Please do not call it in your Release build. | ||
|
|
@@ -122,7 +125,6 @@ for more information regarding the listed permissions required. | |
| [Bluetooth peripheral usage](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CocoaKeys.html#//apple_ref/doc/uid/TP40009251-SW20), | ||
| and [microphone access in iOS 7 and later](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CocoaKeys.html#//apple_ref/doc/uid/TP40009251-SW25). | ||
|
|
||
|
|
||
| ## Getting started | ||
|
|
||
| ### Import the SDK | ||
|
|
@@ -247,8 +249,7 @@ The following functions are handled by the [SumUp APIs](http://docs.sumup.com/re | |
| * [Account management](http://docs.sumup.com/rest-api/accounts-api/) | ||
| ## Community | ||
| - **Questions?** Get in contact with our integration team by sending an email to | ||
| <a href="mailto:[email protected]">[email protected]</a>. | ||
| - **Questions?** Get in contact with our integration team by sending an email to [email protected]. | ||
| - **Found a bug?** [Open an issue](https://github.com/sumup/sumup-ios-sdk/issues/new). | ||
| Please provide as much information as possible. | ||
|
|
||
Oops, something went wrong.