Magento Weicot Json Api 文档 可用于 Java 和 JavaScript 等

7天成为Magento系统架构师,现在开始学习Magento全栈开发!

《Magento2.X企业级开发实战》

WEICOT JSON JAVA JAVASCRIPT 通用 API 插件 本网站有售

/**
 * Mageto Api Json
 * User: ajiang
 * WebSite: WWW.WEICOT.COM
 * Date: 2016/6/21 0021
 * Time: 09:00 v0.23
 */

购买此接口
我将提供
安卓 Java Json 或 Soap 解析器源码 以及相应模块
WEB JavaScript Json 解析器 及模块源码

API 基本流程

获取产品 流程
1.获得目录
2.获得产品列表
3.获得产品信息
4.筛选产品

注册-支付 流程
1.注册 / 登陆
2.更新地址
3.创建订单
4.付款
5.更新订单
订单流程结束

本接口直接调用内部函数效率 比较高 可以缓存

接口 规范

请求结构: 以产品列表为例

http://weicot.com/weicot/api?session=xxxxxxxx&action=productlist&catalogid=4&page=1

 返回结构:
 统一返回json

  格式:
  id=sdf*fD4fsf$Df4aD*!%cvsvewt%6Ddff         通用授权码 app授权id由服务器端设置  只用授权一次 就可获得session
  session=xxxxxxxx  会话 由客户端设置  每个客户端唯一的识别码
  action=cataloglist  所要执行的模块
注意 V1 接口 和 V2 接口 这里不一样

V1 接口: 不兼容V2

 action=cataloglist  所要执行的模块

 这里 cataloglist[方法名] == 方法名

action 已有的模块:
  - cataloglist   //目录列表
  - productlist   //产品列表
  - productinfo   //产品信息
  - filter        //属性筛选
 ...

V2 接口: 兼容V1

action=catalog.list 

这里 catalog[模块名].list[方法名] ==模块名.方法名

action 已有的模块:
  - catalog.list   //目录列表
  - product.list   //产品列表
  - product.info   //产品信息
  - filter.filter        //属性筛选
 ...

以V1 和其函数为例 数据未经加密

明文传输 有被拦截的封风险
建议 对数据加密后传输

产品

http://test/weicot/api??正式接口
http://test/weicot/ap 测试 接口

1.获得产品目录

http://www.test/weicot/api?id=[ID KEY]&session=[SESSION KEY]&action=cataloglist

请求数据

http://www.test/weicot/api?id=[ID KEY]&session=[SESSION KEY]
&action=cataloglist

返回数据

{
  "catalog":[
    {
      "rootCatalogId":"4", //目录ID
      "rootCatalogName":"全部车型" //Title
    },
    . . .
    {
      "rootCatalogId":"432",
      "rootCatalogName":"汽车金融"
    }
  ],
  "childCatalog":[
    {
      "childCatalogId":"9",
      "childCatalogName":"别克"
    },
    {
      "childCatalogId":"10",
      "childCatalogName":"大众"
    },
    {
      "childCatalogId":"11",
      "childCatalogName":"本田"
    },
 ?. . .
    {
      "childCatalogId":"435",
      "childCatalogName":"3"
    }
  ]
}

2.获得产品列表

http://www.test/weicot/api?session=[SESSION KEY]&action=productlist&catalogid=10&page=1

请求数据

http://www.test/weicot/api?session=[SESSION KEY]
&action=productlist
&catalogid=10?目录ID
&page=1?第几页 (默认一页20个)

返回数据

{
  "products":[
    {
      "uid":"508",
//产品ID
      "title":"上汽大众 朗行 ",
      "href":"http://www.test/dz7-5.html"
//产品链接,
      "imgPath":"http://www.test/media/catalog/product/cache/1/thumbnail/9df78eab33525d08d6e5fb8d27136e95/d/z/dz7-11_4.jpg",
//主图
      "remark":"¥?11.29万",
//价格
      "special_price":"¥?11.29万",
//特价
      "subTitle":":贴膜 脚垫 挡泥板 行车记录仪"
//短描述
    },
...
    {
      "uid":"545",
      "title":"上汽大众 帕萨特",
      "href":"http://www.test/dz11-a1.html",
      "imgPath":"http://www.test/media/catalog/product/cache/1/thumbnail/9df78eab33525d08d6e5fb8d27136e95/d/z/dz11-11.jpg",
      "remark":"¥?18.39万",
      "special_price":"¥?18.39万",
      "subTitle":":贴膜 脚垫 挡泥板 行车记录仪"
    }

  ]
}

3.获得产品详情

www.test/weicot/api?session=[SESSION KEY]&action=productinfo&productid=508

请求数据

www.test/weicot/api?session=cccc
c&action=productinfo
&productid=508?//产品ID
返回数据
{
  "id":"508", //产品ID
  "name":"上汽大众 朗行 ~2015款 1.6L 手动 风尚版",
  "short_description":":贴膜 脚垫 挡泥板 行车记录仪", //短描述
  "description":"

"", //描述
  "attributes":[ //属性
    {
      "label":"年款",
      "value":"2015款"
    },
    {
      "label":"国别",
      "value":"合资"
    },
    {
      "label":"厂商",
      "value":"上汽大众"
    },
    {
      "label":"级别",
      "value":"紧凑型"
    },
...
    {
      "label":"座椅材质",
      "value":"织物"
    }
  ],
  "option":[ //选项
    {
      "option_id":"1470", //选项子id
      "title":"全款",
      "id":"460" //选项主ID
    },
    {
      "option_id":"1471",
      "title":"置换",
      "id":"460"
    },
    {
      "option_id":"1472",
      "title":"贷款",
      "id":"460"
    }
  ],
  "price":"112900.0000", //价格
  "special_price":112900, //特价
  "image":[//小图
    {
      "image":"http://www.test/media/catalog/product/d/z/dz7-11_4.jpg"
    },
    {
      "image":"http://www.test/media/catalog/product/d/z/dz7-12_2.jpg"
    }
  ],
  "model":"dz7-1", //SKU
  "rating":0,
  "shipping":"0",
  "related_product":{ //相关产品
    "2015款":[
      {
        "title":"1.6L 自动 风尚版", //产品名
        "value":"1254" //产品ID
      },
      {
        "title":"1.6L 手动 舒适版",
        "value":"1255"
      },
      ...
      {
        "title":"1.6L 手动 风尚版",
        "value":"508"
      }
    ]
  },
  "in_stock":1 //是否有货
}

4.筛选

http://m.com/weicot/api?session=[SESSION KEY]&action=filter&price=1-1000&guobie=1&jp=2
filter //属性筛选
price=1-1000 //价格
guobie=1 //国别
jp=2 //级别

注册及结账流程

http://test/weicot/api??正式接口
http://test/weicot/ap 测试 接口

1.登录接口

http://www.test/weicot/api?session=[SESSION KEY]&action=login&email=av@av.com&password=123456

请求数据

http://www.test/weicot/api?session=[SESSION KEY]
&action=login
&email=av@av.com?邮件
&password=123456?密码

返回数据

{
  "status":"OK",
  "userData":"58",
  "addressData":{
    "Addresses":[
      {
        "addressId":"47",
        "name":"vbfdxvsdvsdv ",
        "company":null,
        "zip":"361000",
        "region":"江西省",
        "city":"厦门",
        "district":null,
        "street":"fdgadfg",
        "telephone":"13606027732",
        "fax":null,
        "country":"CN",
        "is_default":"1" //是否默认地址 1 是 0 不是
      },
      {
        "addressId":"81",
        "name":"xxxx12 ",
        "company":null,
        "zip":"100010",
        "region":"天津市",
        "city":"和平区",
        "district":"劝业场街道",
        "street":"劝业场街道",
        "telephone":"13602585958",
        "fax":null,
        "country":"CN",
        "is_default":"0"
      },
      {
        "addressId":"82",
        "name":"vxcc ",
        "company":null,
        "zip":"100010",
        "region":"天津市",
        "city":"和平区",
        "district":"体育馆街道",
        "street":"体育馆街道",
        "telephone":"13606028565",
        "fax":null,
        "country":"CN",
        "is_default":"0"
      }
    ]
  }
}

2.添加到购物车

http://www.test/weicot/api?session=[SESSION KEY]&action=addcat&productid=70&qty=3&optiontype=347&optionid=85&userid=58

请求数据

http://www.test/weicot/api?session=[SESSION KEY]
&action=addcat?动作
&productid=70?产品ID
&qty=3?件数
&optiontype=347?子选项ID [ 如果没有 选项 请留空 如果有多个请这样写 &optiontype1=子选项1 ID &optionid1=选项2 ID? ]
&optionid=85?选项ID [ 如果没有 选项 请留空 ]
&userid=58?用户ID

返回数据

{
  "status":"1",
  "message":"add true"
}

备注 :

产品详情页 中的选项
“option”:[
{
“option_id”:”315″, //子选项ID?optiontype
“title”:”全款”
“id”:”75″ //选项ID?optionid
},

3.注册

http://www.test/weicot/api?session=[SESSION KEY]&action=reg&email=we@wet.com&pas=111111&name=pppppo&tel=10086

备注

注册 之后的地址不是默认地址
更新 后的地址是默认地址

请求数据

http://www.test/weicot/api?session=[SESSION KEY]&
action=reg?动作
&email=we@wet.com?邮件
&pas=111111?密码
&name=pppppo?用户名 默认为 游客
&tel=10086?电话 默认为 NULL

返回数据

0.10 旧接口
{
  "status":"true", 如果 注册信息错误 则返回 false
  "customerId":"93", //顾客ID
  "name":"pppppo",
  "email":"we@wet.com",
  "tel":"10086"
}
0.11 新接口
{
  "status":"true",
  "customerId":"108",
  "name":"pppppo",
  "email":"we@dwessst.com",
  "tel":"10086",
  "addressId":"142" //增加地址Id 用于更新地址
}

错误信息 示范

{
  "status":"false",
  "message":"user_exist"
}

4.更新地址

http://www.test/weicot/api?session=[SESSION KEY]&action=upAddress&addressId=98&name=老王&tel=13502523651&region_id=485&city_id=1&district_id=1&street=sm观察&postcode=10086

备注:

使用 此接口的地址将会成为默认收货地址

请求数据

http://www.test/weicot/api?session=[SESSION KEY]
&action=upAddress
&addressId=98 用户地址ID
&name=老王 姓名
&tel=13502523651 电话
&region_id=485?北京市 -福建省 地址ID
&city_id=1?东城区 -厦门市 地址ID
&district_id=1?东华门街道 -思明区 地址ID
&street=sm广场 具体地址
&postcode=10086 邮编

返回数据

{
  "state":"true", //状态 true 为添加成功 false 为失败
  "addressID":"98" //地址ID
}

备注:

在地址簿中显示的数据

{
        "addressId":"98", /可以有顾客信息 获得
        "name":"老王 ",
        "company":null,
        "zip":"10086",
        "region":"北京市", / 省市区 三级接口
        "city":"东城区",
        "district":"东华门街道",
        "street":"sm广场",
        "telephone":"13502523651",
        "fax":null,
        "country":"CN",
        "is_default":"1" /是否是默认地址
      },

备注:

地址接口 数据为静态数据 建议做java 储存到本地


请求地址?

http://www.test/weicot/api?session=[SESSION KEY]&action=address&code=region
"2":{
      "code":"2", `地址 ID
      "name":"西城区"
    },


请求地址

?http://www.test/weicot/api?session=[SESSION KEY]&action=address&code=city
{
  "485":{
    "1":{
      "code":"1",
      "name":"东城区"
    },
    "2":{
      "code":"2",
      "name":"西城区"
    },


请求地址?

http://www.test/weicot/api?session=[SESSION KEY]&action=address&code=district

5.创建订单 接口

http://www.test/weicot/api?session=[SESSION KEY]&action=createOrder&productId=70&qty=1&optionId=85&optionType=347&email=we@wet.com&pay=chinapay

请求数据

http://www.test/weicot/api?session=[SESSION KEY]&action=createOrder
&productId=70?产品ID
&qty=1?件数
&optionId=85?选项 ID
&optionType=347?子选项ID
&email=we@wet.com?邮件
&pay=chinapay?支付方式 chinapay 银联 alipay_payment 支付宝

返回数据

{
  "state":"true", 状态 错误为false
  "orderID":"100000173" 订单号
}

6.使用服务器端 进行支付

http://www.test/weicot/ap?session=[SESSION KEY]&action=paypal&OrderId=100000173

请求地址

http://www.test/weicot/ap?session=[SESSION KEY]&action=paypal
&OrderId=100000173?订单号

返回数据
返回服务器端的成功页面 不建议使用服务器端支付 因为捕捉订单状态是个麻烦事儿

7.更改订单状态

http://www.test/weicot/ap?session=[SESSION KEY]&action=orderstate&OrderId=100000173&orderStatue=true

请求地址

http://www.test/weicot/ap?session=[SESSION KEY]&action=orderstate
&OrderId=100000173?订单号
&orderStatue=true?订单状态 true?已付款 /?false 新订单

返回数据

  
{
  "state":"true",
  "orderID":"100000173"
}

参考及引用
Magento REST API
Mageto Soap Api
Debugging Magento API Method Calls
PHP 安装 Oauth 扩展

转载请注明:(●–●) Hello.My Weicot » Magento Weicot Json Api 文档 可用于 Java 和 JavaScript 等

文章来源于互联网:Magento Weicot Json Api 文档 可用于 Java 和 JavaScript 等

如无特殊说明或标注,任何个人或组织,复制、转载、采集本站内容请注明:
本文来源于:【Magento中文网】,并添加本文地址链接。
如未按上述操作复制或转载,本站有权追究法律责任。
若本站内容侵犯了原著者的合法权益,可联系我们进行处理。