入门指南

CitrusPay iOS SDK

简介

CitrusPay iOS SDK 可以通过各种支付方式收集支付。

SDK 为开发自身 iOS 应用程序的 CitrusPay 合作伙伴设计。该 SDK 提供了一种原生集成方式，可在这些应用内轻松接受支付，并提供高性能、功能丰富的结账体验。

##功能
CitrusPay iOS SDK 广泛提供以下功能。

核心 SDK V 4.1.5 - CitrusPay.framework

• 为用户创建 Citrus 账户
• 预付费支付
• 通过信用卡/借记卡（CC、DC）或网上银行支付（NB）进行支付
• 遵守支付卡行业数据安全标准（PCI DSS），将信用卡/借记卡保存到用户的账户中，以便于未来的支付
• 为预付费功能将资金加载到用户 Citrus 预付费账户中
• 将预付费账户中的资金提现到用户的银行账户
• 按需加载资产（通过 CitrusGraphics 库）
• 为已保存卡片进行一键支付
• 订阅 Citrus 钱包的定期自动加载
• 分割支付
• 动态定价，提供优惠券，加收费用
• SDK 支持登录屏幕以简化登录过程
• Swift 3.1 支持，与 Xcode 8.3 一起使用

CitrusGraphics SDK V 1.1.2 - CitrusGraphics.framework

• 一个轻量级的纯 Swift 库，用于从 Citrus 云下载和缓存图像
• Swift 3.1 支持，与 Xcode 8.3 一起使用
• 为模块的资产需求提供动态资产
• SDK 提供默认和低分辨率图像，当根据设备规格下载和缓存资产时，将用高分辨率图像替换

LazyPay SDK V 1.0.1 - LazyPay.framework

• LazyPay 结账 - 现在购买，稍后付款！
• 原生 iOS 集成
• 简单轻量级集成
• 使低价值在线购买更加流畅支付
• 提高交易商家成功率

PlugNPlay SDK V 1.1.0 - PlugNPlay.framework

• 原生 iOS 集成
• 简单轻量级集成
• 易于集成和使用库
• 提供一组即用可用的用户屏幕，以便在 iOS 应用中进行支付
• 提供由 Citrus SDK 提供的所有功能的端到端支付体验
• 降低集成摩擦，因为商家无需担心设计结账屏幕、银行资产或处理不同支付方式所需的复杂性
• 支付组件使您能够通过各种支付工具从您的用户那里接受支付，例如 Citrus 钱包、虚拟货币、卡或网上银行
• 钱包/用户资料组件提供一个单一用户界面，使用户能够
  1. 将资金存入用户 Citrus 钱包
  2. 订阅 Citrus 钱包的定期自动加载
  3. 管理已保存的卡片
  4. 将资金从他的 Citrus 钱包提现到银行账户

####完整的SDK 更改日志也可用

示例项目

您可以通过CocoaPods或手动包含来尝试和使用Citrus Payments SDK。此项目随SDK一起提供。

通过CocoaPods - 要运行示例项目，首先从示例目录中克隆repo并运行pod install。

示例应用需求

• 需要Xcode 8或更高版本。

###与Citrus PG集成的先决条件

• 您需要作为商家在Citrus注册。
• 您需要在您的服务器上托管账单生成器。
• 您需要在您的服务器上托管返回URL页面。（交易完成后，Citrus会向该URL发送响应。）
• 请确保您已从您的Citrus管理员面板中获取以下参数
• 商家密钥
• 商家访问密钥
• 登录密钥
• 登录密钥
• 注册密钥
• 注册密钥

注意：在继续之前，请确保满足上述所有要求。

设置

一切皆有始；对于框架的使用，其开始即是安装。

将SDK作为Git子模块包含

如果您不想使用CocoaPods，那么次要建议是使用子模块。这允许您使用标准的Git命令轻松跟踪更新。安装的第一步是将子模块添加到您的项目中

$ cd /path/to/MyApplication
# If this is a new project, initialize git...
$ git init
$ git submodule add git://github.com/citruspay/citruspay-ios-sdk.git
$ git submodule update --init --recursive
$ open citruspay-ios-sdk

• 导航到"框架"文件夹，并将"core-sdk"文件夹拖入您现有的Xcode项目
• 选择目标，导航到构建阶段标签，展开与库链接部分
• 单击+，选择与您的目标平台相关的CitrusPay.framework
• 然后导航到常规标签，展开嵌入的二进制文件部分
• 单击+，选择与您的目标平台相关的CitrusPay.framework

手动包含

如果您想手动下载并维护SDK，请按照以下步骤操作

• 使用以下命令克隆：

$ git clone --recursive https://github.com/citruspay/citruspay-ios-sdk.git
$ open citruspay-ios-sdk

• 导航到Citrus的"框架"文件夹，并将"core-sdk"文件夹拖入您现有的Xcode项目
• 在Xcode中，转到您的应用目标设置。在构建阶段标签下，展开与库链接部分。
• 包含以下框架：

• CitrusPay.framework

• 在Xcode中，转到您的应用目标设置。在常规标签下，展开嵌入的二进制文件部分。
• 包含以下框架：

• CitrusPay.framework

添加依赖项（在将SDK作为子模块包含以及手动包含时需要）

JSONModel

• 导航到"依赖"文件夹，并将子文件夹中的JSONModel.xcodeproj拖到您的Xcode项目中（即使用直接项目依赖）
• 选择目标，导航到构建阶段标签，展开与库链接部分
• 单击+并选择与您的目标平台相关的JSONModel.framework
• 然后导航到常规标签，展开嵌入的二进制文件部分
• 单击+并选择与您的目标平台相关的JSONModel.framework

CitrusGraphics

• 导航到"框架"文件夹，并将"graphics-sdk"文件夹拖入您现有的Xcode项目
• 选择目标，导航到构建阶段标签，展开与库链接部分
• 单击+并选择与您的目标平台相关的CitrusGraphics.framework
• 然后导航到常规标签，展开嵌入的二进制文件部分
• 单击+并选择与您的目标平台相关的CitrusGraphics.framework

Kingfisher

• 导航到"依赖"文件夹，并将子文件夹中的Kingfisher.xcodeproj拖到您的Xcode项目中（即使用直接项目依赖）

• 选择目标，导航到构建阶段标签，展开与库链接部分

• 单击+并选择与您的目标平台相关的Kingfisher.framework

• 然后导航到常规标签，展开嵌入的二进制文件部分

• 单击+并选择与您的目标平台相关的Kingfisher.framework

• 将您的应用链接到SystemConfiguration.framework

• 完成！

下一步

安装完成后，您必须通过添加以下内容将CitrusPay SDK导入到项目中

Swift

import CitrusPay

Objective-C

#import <CitrusPay/CitrusPay.h>

到您想要使用此框架的文件中。

准备好后，继续查看文档，了解如何使用CitrusPay。

文档

HTML文档托管在我们的CitrusPay开发人员指南上。

Git Wiki文档可在Git Wiki文档中找到。

SDK组织

CitrusPay.h

```CitrusPay.h```是使用SDK的起点，并包含您将要交互的主要类。
它公开了您可以调用的所有方法，以通过支持的支付方式接收付款。
详细的参考文档可在CitrusPay类的参考页面找到。

数据模型

SDK中的其他所有类都是数据模型，用于在您的应用和SDK之间交换数据。
每个类的详细参考文档都在相应的参考页面。

下一步

前往Git Wiki 文档查看所有可用的API方法。

查看最新的发布页面

下一步

前往Git Wiki 文档查看所有可用的API方法。
准备好后，查看下面的示例来学习如何与SDK交互。