菜单

Shopify应用对接指南

对接shopify一共只需要两个步骤,根据以下指引完成即可

第一步:添加产品

首次注册及后续添加产品可在左上角操作"添加产品"

产品表单填写指引介绍

产品LOGO:在PartnerShare推广市场展示的LOGO
产品名称:在PartnerShare推广市场展示的名称
与PartnerShare结算货币:美元
产品类型:shopify插件
Shopify应用商店列表链接:例如 https://apps.shopify.com/YourApp
Shopify合作伙伴ID:在Shopify合作伙伴后台 "设置" -> "合作伙伴 API 客户端" 下找到它

Shopify合作伙伴API客户端访问令牌:

重要提示! PartnerShare平台需要您应用的 API 权限,这样我们才能判断安装是否通过推广链接进行,并正确计算交易金额和奖励金额。
这些权限授予我们“只读”访问权限,我们仅使用该访问权限读取与PartnerShare平台相关的信息。
我们不会读取您与 PartnerShare 集成之前的任何数据。
您可以在在此处找到有关合作伙伴 API 权限的更多信息。

假设您是首次创建API客户端访问令牌,可以按照下面指引跟截图获取API客户端访问令牌

  1. 在Shopify合作伙伴后台 "设置" -> "合作伙伴 API 客户端" 下找到它
  2. 创建API客户端,并勾选财务信息管理应用权限
  3. 获取到访问令牌填入产品信息




Shopify应用程序ID:

在您应用的合作伙伴管理页面链接上找到它并复制。

例如:

https://partners.shopify.com/1111111/apps/**1234567**/#

1234567 是您的应用程序 ID。

校验API连接

要成功创建应用开始推广,您必须验证与 Shopify Partners API 的连接,以确保您输入的详细信息正确无误。

如果以上步骤没错,在Partnershare点击校验链接,通过后点击提交,提示提交成功则完成第一步对接啦~

第二步:POST请求

要最终完成对接,您需要向您的应用添加 POST 请求。此请求将帮助我们正确匹配到属于合作伙伴的受邀用户。

每次新商店安装应用时都必须运行该请求。

将代码添加到您的应用

当 OAuth 完成后,您将收到来自 Shopify 的请求,其中包含商店名称和“X-Forwarded-For”标头。

当您拥有这些值时,您需要发送包含以下数据的 POST 请求(一共四个参数):

conversion_token,shop_name,app_id,xff

参数解释:
conversion_token: PartnerShare数据回传密钥 获取路径:PartnerShare后台->设置-> 集成
shop_name: 当前登录应用程序的商店的店铺名称。(完整,例如newshop.myshopify.com
app_id:您的 Shopify 应用的 ID。要找到它,请转到应用的合作伙伴管理页面,然后从网址链接中复制它。例如:“ https://partners.shopify.com/1111111/apps/1234567#/”,1234567 就是您的应用 ID。
xff: shopify请求头值'X-Forwarded-For'

不同语言获取请求头值示例

node: ctx.request.header['x-forwarded-for']
ruby: request.env["HTTP_X_FORWARDED_FOR"]
PHP: $_SERVER["HTTP_X_FORWARDED_FOR"]

curl请求示例

shell 复制代码
curl -X POST https://api.partnershare.net/partner/conversion/new-merchant
   -H 'Content-Type: application/json'
   -d '{"conversion_token":"xxxxxx",
   "shop_name":"xxxxxxx.myshopify.com",
   "app_id":"1111111",
   "xff":"11.1111.111.111"}'

node.js请求示例

node 复制代码
await fetch('https://api.partnershare.net/partner/conversion/new-merchant', { 
    method: 'POST', 
    headers: { 'Content-Type': 'application/json' }, 
    body: JSON.stringify({ conversion_token: "xxxxxx", shop_name: "xxxxx.myshopify.com", app_id: "111111", xff: "11.1111.111.111" }) 
})

测试请求

您可以直接在PartnerShare上进行测试,后续可以联系我们的工作人员为您清除测试数据。

发起请求

添加 POST 请求后,您需要从应用的合作伙伴管理后台打开一个新的开发商店,安装并打开您的应用程序。 我们的系统首次收到请求后,产品对接状态将更改为“审核中”,我们的客户经理会联系您。

对接状态

对接中:与合作伙伴 API 的连接已成功。还差进行POST 请求。

审核中:我方收到 POST 请求。正在审核您的应用,审核通过后将会有客户经理联系您。

上一个
推荐阅读:高频FAQ
下一个
什么是“奖励规则”
最近修改: 2024-07-26Powered by