GoodieCore 版本 0.3.2

GoodieCore 版本 0.3.2

×

由 sdk ios 维护。

GoodieCore 版本 0.3.2

  • 作者
  • shurahman

GoodieCore - 为 iOS 的忠诚度 API

使用 Goodie Core SDK 启用移动应用程序和 Web 中的自定义忠诚度

CI Status Version License Platform

主要功能

功能 描述
Lite 版本 Goodie SDK 无 UI 的 Goodie SDK

功能

  • 注册
  • 验证会员
  • 登录
  • 会员积分
  • 会员资料
  • 促销查询
  • 促销发布
  • 奖励列表
  • 兑换奖励
  • 优惠券余额
  • 兑换优惠券
  • 更改密码
  • 更新会员资料
  • 历史记录（积分交易历史）列表

安装

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

$ gem install cocoapods

要在使用 CocoaPods 的 Xcode 项目中集成 GoodieCore，请在 Podfile 中指定它

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

target '<Your Target Name>' do
pod 'GoodieCore',
end

然后，运行以下命令

$ pod install

注册会员

该注册操作通过调用Goodie.register()函数完成。此函数将检索或创建用户。进行请求您需要为您的设备（例如HP）实现获取'deviceUniqueId'的函数。以下是一个示例

GoodieCore.register(username: "username", merchantId: "merchantId", phoneNumber: "phoneNumber", password: "password", firstName: "firstName", lastName: "lastName",   deviceUniqueId: "deviceUniqueId", birthDate: "18-01-1992", referralCode: "referralCode", completion: { (RegisterResponse) in
    if RegisterResponse.abstractResponse?.responseStatus == "MEM000" {
        //success
    }else{
        //failed
    }
}) { (Error) in
    //error
}

验证会员

验证操作通过调用Goodie.verification()函数完成。此函数将基于用户名、merchantId和verificationCode进行检索。在我们的后端系统中，有一个名为“isVerification”的标志，如果您将此标志设置为true，则用户需要填写验证码以激活其账户。（我们的后端系统将通过电子邮件或短信发送验证码）以下是一个示例

GoodieCore.verification(username: "username", merchantId: "merchantId", code: "verificationCode", completion: { (VerificationResponse) in
    if VerificationResponse.abstractResponse?.responseStatus == "MEM000" {
        //success
    }else{
        //failed
    }
}) { (Error) in
    //error
}

身份验证/登录

登录通过调用Goodie.setLogin()函数完成。此函数将基于deviceUniqueId、用户名、密码和merchantCode进行检索。登录Goodie系统以访问Goodie功能。以下是一个示例

GoodieCore.login(deviceUniqueId: "deviceUniqueId", username: "username", password: "password", merchantCode: "merchantCode", completion: { (LoginResponse) in
    if LoginResponse.abstractResponse?.responseStatus == "AUTH000" {
        //success, do something
    }else{
        //failed
    }
}) { (Error) in 
    //error
}

会员积分

通过调用Goodie.memberPoint()函数完成会员积分操作。此函数将基于memberId和merchantId进行检索。您可以使用此函数查看您的积分余额（您可以通过完成一定金额的交易或参加某些活动获得积分）。以下是一个示例

GoodieCore.memberPoint(authToken: "autToken", deviceUniqId: "deviceUniqId", memberId: "memberId", merchantId: "merchantId", completion: { (MemberPointResponse) in
    if MemberPointResponse.abstractResponse?.responseStatus == "INQ000" {
        //success, do something
    }else{
        //failed
    }
}) { (Error) in
     //error
}

会员资料

您可以使用此函数检索存储在Goodie系统中的会员数据。以下是一个示例

GoodieCore.memberProfile(authToken: "authToken", deviceUniqId: "deviceUniqId", memberId: "memberId", merchantId: "merchantId", completion: { (MemberProfileResponse) in
    if MemberProfileResponse.abstractResponse?.responseStatus == "INQ000" {
        //success, do something
    }else{
        //failed
    }
}) { (Error) in
    //error
}

促销查询基本信息

此促销查询基本信息是通过调用 Goodie.setPromotionInquiryBasic() 函数实现的。以下是示例

GoodieCore.promotionInquiryBasic(authToken: "authToken", deviceUniqId: "deviceUniqId", memberId: "memberId", merchantId: "merchantId", storeId: "storeId", productCode: "productCode", refNumber: "refNumber", totalTrxAmount: 10000, completion: { (PromoInqBasicResponse) in
    if PromoInqBasicResponse.abstractResponse?.responseStatus == "INQ000" {
        //success, do something
    }else{
        //failed
    }
}) { (Error) in

}

促销发布基本信息

此促销发布基本信息是通过调用 Goodie.promotionPostingBasic() 函数实现的。以下是示例

GoodieCore.promotionPostingBasic(authToken: "authToken", deviceUniqId: "deviceUniqId", memberId: "memberId", merchantId: "merchantId", storeId: "storeId", productCode: "productCode", refNumber: "refNumber", totalTrxAmount: 100000, completion: { (PromoInqBasicResponse) in
    if PromoInqBasicResponse.abstractResponse?.responseStatus == "INQ000" {
        //success, do something
    }else{
        //failed
    }
}) { (Error) in
    //error
}

奖励列表

您可以通过调用 Goodie.rewardList() 函数从 goodie 获取奖励列表。使用此函数，您可以显示奖励详细信息。如果将 rewardId 参数填充为空字符串，则函数将检索所有奖励。如果想要检索特定奖励，则可以将 rewardId 参数填充为从上一个奖励列表中获取的特定 id。以下是示例

orderBy : 
1 = ascending
2 = descending

orderType :
1 = reward
2 = product
3 = point
4 = expired date

nRecord = number of records

GoodieCore.rewardList(authToken: "authToken", deviceUniqueId: "deviceUniqueId", keyword: "keyword", rewardId: "rewardId", memberId: "memberId", merchantId: "merchantId", orderBy: "1", orderType: "1", nRecords: "10", page: "0", completion: { (RewardListResponse) in
    if RewardListResponse.abstractResponse?.responseStatus == "INQ000" {
        //success, do something
    }else{
        //failed
    }
}) { (Error) in
    //error
}

奖励兑换

这个函数 Goodie.reedemReward() 用于将积分兑换成奖励。您可以在从奖励列表函数获取响应时获取 rewardId。以下是一个示例

GoodieCore.reedemReward(authToken: "authToken", deviceUniqId: "deviceUniqId", memberId: "memberId", merchantId: "merchantId", rewardId: "rewardId", quantity: 1, completion: { (RewardRedemptionResponse) in

    if RewardRedemptionResponse.abstractResponse?.responseStatus == "RWRED000" {
         //success, do something
    }else{
        //failed
    }

}) { (Error) in
    print("error")
}

我的奖励列表

这个函数 Goodie.voucherBalance() 用于显示您拥有的所有奖励。在您用积分兑换奖励后，它将显示在此处。以下是示例

orderBy : 
1 = ascending
2 = descending

orderType :
1 = reward
2 = product
3 = point
4 = expired date

nRecord = number of records

GoodieCore.voucherBalance(authToken: "authToken", deviceUniqueId: "deviceUniqueId", voucherBalanceId: "voucherBalanceId", memberId: "memberId", merchantId: "merchantId", orderBy: "1", orderType: "1", nRecords: "10", page: "0", completion: { (VoucherBalanceResponse) in
    if VoucherBalanceResponse.abstractResponse?.responseStatus == "INQ000" {
        //success, do something
    }else{
        //failed
    }
}) { (Error) in
    //error
}

兑换优惠券

该函数Goodie.voucherUsage()用于兑换您的优惠券（您可以通过兑换积分来获得优惠券），以下是一个示例

GoodieCore.voucherUsage(authToken: "authToken", deviceUniqueId: "deviceUniqueId", memberId: "memberId", merchantId: "merchantId", voucherBalanceId: "voucherBalanceId", storeId: "storeId", completion: { (VoucherUsageResponse) in
    if VoucherUsageResponse.abstractResponse?.responseStatus == "INQ001" {
        //success, do something
    }else{
        //failed
    }
}) { (Error) in
    //error
}

修改密码

您可以使用此功能在Goodie系统中使用新的密码更改现有的密码。以下是示例代码

GoodieCore.changePassword(authToken: "authToken", deviceUniqueId: "deviceUniqueId", passwordOld: "passwordOld", newPassword: "newPassword", confirmPassword: "confirmPassword", memberId: "memberId", merchantId: "merchantId", username: "username", completion: { (ChangePasswordResponse) in
    if ChangePasswordResponse.abstractResponse?.responseStatus == "MEM902" {
        //success, do something
    }else{
        //failed
    }
}) { (Error) in
     //error
}

更新会员资料

使用Goodie.updateMemberProfile()可以用于更新Goodie系统中的个人资料，您可以通过此函数更改个人信息。以下是示例代码

GoodieCore.updateMemberProfile(authToken: "authToken", deviceUniqueId: "deviceUniqueId", memberId: "memberId", merchantId: "merchantId", birthDate: "birthDate", firstName: "firstName", lastName: "lastName", gender: "gender", phoneNumber: "phoneNumber", completion: { (UpdateMemberProfileResponse) in
    if UpdateMemberProfileResponse.abstractResponse?.responseStatus == "MEM000" {
        //success, do something
    }else{
        //failed
    }
}) { (Error) in
     //error
}

积分交易历史

您可以使用Goodie.listHistory()函数跟踪您的发积分历史记录和兑换积分历史记录。以下是示例代码

orderBy : 
1 = ascending
2 = descending

orderType :
1 = reward
2 = product
3 = point
4 = expired date

trxType : 
0 = It’s mean all data will retrieve (Issuing and Redeemed)
1 = It will retrieve only Issuing data history
2 = It will retrieve only Redeemed data history

nRecord = jumlah record dalam string

GoodieCore.listHistory(authToken: "authToken", deviceUniqueId: "deviceUniqueId", memberId: "memberId", merchantId: "merchantId", trxType: "1", orderBy: "1", orderType: "1", nRecords: "10", page: "0", completion: { (ListPointTransactionResponse) in
    if ListPointTransactionResponse.abstractResponse?.responseStatus == "TRX018" {
        //success, do something
    }else{
        //failed
    }
}) { (Error) in
    //error
}

作者

Shu先生，[email protected]

许可证

GoodieCore根据MIT许可证提供。有关更多信息，请参阅LICENSE文件。