入门指南

CitrusPay iOS SDK 的

简介

CitrusPay iOS SDK 允许通过各种支付方式收取支付。

此 SDK 设计用于 CitrusPay 合作伙伴，他们正在开发自己的 iOS 应用程序。该 SDK 提供了内置的原生集成，易于集成并提供高性能、功能齐全的结账体验，以便在这些应用程序中接受支付。

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

核心 SDK V 4.1.5 - CitrusPay.framework

• 为用户创建 Citrus 账户
• 预付费支付
• 通过信用卡/借记卡（CC，DC）或网上银行支付（NB）进行支付
• 按规定将信用卡/借记卡保存到用户的账户中，以便今后轻松支付
• 将资金加载到用户的 Citrus 预付费账户中，以便预付费功能
• 将从预付费账户中的资金提现回用户的银行账户
• 按需资产加载（通过 CitrusGraphics 库
• 为已保存的卡提供一键支付
• 订阅 Citrus 钱包的定期自动加载
• 分割支付
• 动态定价，提供优惠券，附加费
• SDK 支持登录界面，以简化登录
• Swift 版本 3.1 支持与 Xcode 8.3

CitrusGraphics SDK V 1.1.2 - CitrusGraphics.framework

• 一个用于从 Citrus 云端下载和缓存图片的轻量级、纯 Swift 库
• 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 历史记录可以通过以下链接查看ChangeLog

示例项目

您可以通过 CocoaPods 或手动添加来下载示例项目，以尝试并熟悉 Citrus Payments SDK。该项目与 SDK 一起打包。

通过 CocoaPods - 要运行示例项目，首先克隆仓库，然后在 Example 目录中运行 pod install。

示例应用程序要求

• 支持 Xcode 8 或更高版本。

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

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

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

配置

万事开头难。使用框架，首先要进行安装。

使用 CocoaPods（推荐）

CocoaPods 是 Cocoa 项目的依赖管理器。您可以使用以下命令安装它

$ gem install cocoapods

要使用 CocoaPods 将 CitrusPay 集成到您的 Xcode 项目中，请在 Podfile 中指定它为您的目标

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!

target 'MyApp' do
# your other pod
# ...
pod 'CitrusPay', '~> 4.1.5'
end

然后，运行以下命令

$ pod install

• 完成！

在您从 CocoaPods 安装任何内容后，应该打开 {Project}.xcworkspace，而不是 {Project}.xcodeproj。

作为 Git 子模块包含 SDK

如果您不想使用 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

• 导航到 "Framework" 文件夹 & 将 "core-sdk" 文件夹拖放到现有的 Xcode 项目中
• 选择目标，并导航到 Build Phases 选项卡，展开 Link Binary With Libraries 部分
• 单击“+”并选择适合您目标平台的 CitrusPay.framework
• 然后导航到 General 选项卡并展开 Embedded Binaries 部分
• 单击“+”并选择适合您目标平台的 CitrusPay.framework

手动包含

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

• 使用以下命令克隆它

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

• 导航到 Citrus 的 "Framework" 文件夹 & 将 "core-sdk" 文件夹拖放到现有的 Xcode 项目中
• 在 Xcode 中，转到您应用程序的目标设置。在 Build Phases 选项卡下，展开 Link Binary With Libraries 部分。
• 包括以下框架

• CitrusPay.framework

• 在 Xcode 中，转到您应用程序的目标设置。在 General 选项卡下，展开 Embedded Binaries 部分。
• 包括以下框架

• CitrusPay.framework

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

JSONModel

• 导航到 "Dependency" 文件夹 & 将子文件夹中的 JSONModel.xcodeproj 拖放到您的 Xcode 项目中（即使用直接项目依赖关系）
• 选择目标，并导航到 Build Phases 选项卡，展开 Link Binary With Libraries 部分
• 单击“+”并选择适合您目标平台的 JSONModel.framework
• 然后导航到 General 选项卡并展开 Embedded Binaries 部分
• 单击“+”并选择适合您目标平台的 JSONModel.framework

CitrusGraphics

• 将 "graphics-sdk" 文件夹拖放到现有 Xcode 项目中的 "Framework" 文件夹
• 选择目标，并导航到 Build Phases 选项卡，展开 Link Binary With Libraries 部分
• 单击“+”并选择适合您目标平台的 CitrusGraphics.framework
• 然后导航到 General 选项卡并展开 Embedded Binaries 部分
• 单击“+”并选择适合您目标平台的 CitrusGraphics.framework

Kingfisher

• 将子文件夹中的 Kingfisher.xcodeproj 拖放到您的 Xcode 项目中（即使用直接项目依赖关系）

• 选择目标，并导航到 Build Phases 选项卡，展开 Link Binary With Libraries 部分

• 单击“+”并选择适合您目标平台的 Kingfisher.framework

• 然后导航到 General 选项卡并展开 Embedded Binaries 部分

• 单击“+”并选择适合您目标平台的 Kingfisher.framework

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

• 完成！

下一个

安装后，您必须将 CitrusPay SDK 添加到项目中，具体操作如下

Swift

import CitrusPay

Objective-C

#import <CitrusPay/CitrusPay.h>

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

一切准备就绪后，请查看文档以了解如何使用 CitrusPay。

文档

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

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

SDK组织

CitrusPay.h

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

数据模型

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

后续步骤

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

查看最新的发布页面

后续步骤

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