VGS Collect - is a product suite that allows customers to collect information securely without possession of it. VGSCollect iOS SDK allows you to securely collect data from your users via forms without having to have that data pass through your systems. The form fields behave like traditional input fields while securing access to the unsecured data.
You should have your organization registered at VGS Dashboard. Sandbox vault will be pre-created for you. You should use your <vaultId>
to start collecting data. Follow integration guide below.
VGSCollectSDK is available through CocoaPods and Carthage.
CocoaPods is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate VGSCollectSDK into your Xcode project using CocoaPods, specify it in your Podfile
:
pod 'VGSCollectSDK'
VGCollectSDK is also available through Carthage.
Add the following line to your Cartfile
:
github "verygoodsecurity/vgs-collect-ios"
then run:
carthage update --platform iOS
Note that VGSCollectSDK
includes CardIO as dependency for scanning card numbers. You should also link it to your project. Follow the Carthage instructions
import VGSCollectSDK
Use your <vaultId>
to initialize VGSCollect instance. You can get it in your organisation dashboard.
VGSCardTextField automatically detects card provider and display card brand icon in the input field.
VGSCollect provide secure card.io integration for collecting and setting scanned data into VGSTextFields
.
To use card.io with VGSCollectSDK you should add CardIO module alongside with core VGSCollectSDK module into your App Podfile:
pod 'VGSCollectSDK'
pod 'VGSCollectSDK/CardIO'
Handle VGSCardIOScanControllerDelegate
functions. To setup scanned data into specific VGSTextField implement textFieldForScannedData:
. If scanned data is valid it will be set in your VGSTextField automatically after user confirmation. Check CradIODataType
to get available scand data types.
Don't forget to add NSCameraUsageDescription key and description into your App Info.plist
.
You can add a file uploading functionality to your application with VGSFilePickerController.
Use vgsCollect.cleanFiles() to unassign file from associated VGSCollect instance whenever you need.
Demo application for collecting card data on iOS is here.
- SDK Documentation: https://www.verygoodsecurity.com/docs/vgs-collect/ios-sdk
- API Documentation: https://verygoodsecurity.github.io/vgs-collect-ios/
To follow VGSCollectSDK
updates and changes check the releases page.
- iOS 10+
- Swift 5
- 3rd party libraries:
- CardIO(optional)
VGSCollect iOS SDK is released under the MIT license. See LICENSE for details.