ParchePartnerURLScheme 1.0.1

ParchePartnerURLScheme 1.0.1

测试已测试
语言语言 Obj-CObjective C
许可证 自定义
发布最新发布2015年3月

Ellen ShapiroSean WolterCarl Hill-Popper 维护。



  • 作者:
  • Ellen Shapiro

Parche-PartnerURLScheme

Parche 合作伙伴 URL 方案旨在简化合作伙伴应用程序会员的代金券生成。

任何合作伙伴应用程序都需要执行以下步骤进行集成

  1. 设置您的服务器以调用 Parche 代金券 API。
  2. 设置您的应用程序以从您的服务器获取该调用的结果。
  3. 使用提供的方便类调用 URL 方案并将数据发送到 Parche 应用程序。

方便类还将包括方法来检测用户是否已安装了支持此 URL 方案的 Parche 应用程序,以及直接打开适当的 App Store 并跳转到 Parche 应用程序。

与您的服务器集成

当您与 Parche 签约时,您将收到一个 API 密钥 和一个 API 密钥

为了提高安全性并防止重放攻击,我们 强烈建议 从您的服务器而不是直接从您的应用程序调用 Parche 代金券 API。这有几个安全优势

  • 不需要在您的应用程序中存储您的 API 密钥。
  • 由于它基本上没有密钥就毫无用处,因此您可以在应用程序中以纯文本形式存储您的 API 密钥。
  • 如果在出现事故的情况下需要更换密钥,这将允许即时替换,而不是等待更新发布。

虽然从您的应用程序调用代金券 API 是可能的,但如果您这样做,您将承担您的 API 密钥被泄露的风险。

代金券 API

对代金券 API 的所有调用都相对于基本 URL

  • 测试环境:https://api-staging.goparche.com
  • 生产环境:https://api.goparche.com

对从 iOS App Store 或 Google Play 商店下载的应用程序版本进行测试的所有内容都应使用生产基本 URL。

如果您正在使用应用程序的测试版进行测试,Parche 将告知您应使用哪个 API 基本URL。

为合作伙伴应用程序用户获取代金券

POST: /v1/partner/:api_key/create_discount``

正文

{
    "partner_user_id": "[email protected]",
    "api_secret": "[your API secret]"
}

注释

  • partner_user_id:您的系统用来引用当前用户的用户 ID(字符串)
  • api_key:Parche 提供给您的 API 密钥(字符串)
  • api_secret:Parche 提供给您的 API 密钥(字符串)

响应

{
    "discount_code": "UYGgYtg76GUIHIUHiuhIUhi7y8d120dkasd0mnjv"
}

注释

  • discount_code:向应用程序传递的折扣代码。(字符串)

状态码

  • 201:如果折扣代码已创建
  • 400:如果请求中的字段不正确
  • 403:如果提供错误的API密钥或API密钥

与应用程序集成

对于每个平台都有辅助类,以方便您的应用程序调用Parche URL方案。这些类中的每一个都将需要您传递

  • API密钥
  • 您的系统用来引用当前用户的用户ID
  • 通过调用折扣代码API生成的折扣代码。

有关如何通过iOS和Android README文件中的辅助类集成到您的应用程序中的说明,请参阅iOSAndroid

iOSAndroid 文件夹包含了示例应用程序,展示了如何执行此集成。