App加Web项目 Opencart Api接口文档,简体版

搜寻

接口描述

URLindex.php?route=product/search/api
功能描述通过关键词搜商品
返回格式Json,UTF8
HTTP请求方式GET

业务参数

参数名参数全称必选参数类型参数描述
searchsearchtrueString查询关键词
limitlimitfalseInt每页返回结果数  默认:15
pagepagefalseInt查询第几页数据

返回参数

参数名参数全称必选参数类型参数描述
totaltotaltrueInt结果条数
product_idproduct_idtrueInt商品 ID
thumbthumbtrueString图片地址
namenametrueString名称
descriptiondescriptiontrueString描述
pricepricetrueString价格
specialspecialtrueString优惠价格
taxtaxtrueString价格含税
minimumminimumtrueInt最小起订数量
ratingratingtrueInt评价
hrefhreftrueString商品 API
searchsearchtrueString关键词

调用示例

index.php?route=product/search/api&search=abc

响应示例

{
    "total": "1",
    "products": [
        {
            "product_id": "80",
            "thumb": "image/cache/catalog/TB2fhHlb4vzQeBjSZFxXXXLBpXa_!!12883669.jpg_270x270-300x300.jpg",
            "name": "LED 家具灯",
            "description": "..",
            "price": "HK $300.00",
            "special": "HK $290.00",
            "tax": false,
            "minimum": "1",
            "rating": 0,
            "href": "index.php?route=product/product/api&product_id=80&search=abc"
        }
        ......
    ],
    "search": "abc"
}


热门推介

接口描述

URLindex.php?route=common/home/featured_api
功能描述热门推介
返回格式Json,UTF8
HTTP请求方式GET

返回参数

同上

调用示例

index.php?route=common/home/featured_api

响应示例

{
    "products": [
        {
            "product_id": "76",
            "thumb": "image/cache/catalog/TB2fhHlb4vzQeBjSZFxXXXLBpXa_!!12883669.jpg_270x270-300x300.jpg",
            "name": "女士服装",
            "description": "..",
            "price": "HK $300.00",
            "special": "HK $288.00",
            "tax": false,
            "rating": 0,
            "href": "index.php?route=product/product/api&product_id=76"
        }
        ......
    ]
}


会员注册

接口描述

URLindex.php?route=account/register/api
功能描述会员注册
返回格式Json,UTF8
HTTP请求方式POST

业务参数

参数名参数全称必选参数类型参数描述
firstnamefirstnametrueString名字
lastnamelastnametrueString姓氏
gendergendertrueString性别  M(ale):男  F(emale):女
emailemailtrueString电子邮箱
passwordpasswordtrueString密码
confirmconfirmtrueString确认密码
agreeagreetrueInt閱讀並同意 Privacy Policy      1:有效,0:没有
captchacaptchatrueString验证码

返回参数

参数名参数全称必选参数类型参数描述
successsuccesstrueString
warningwarningtrueString错误信息

调用示例

index.php?route=account/register/api

调用验证码

index.php?route=extension/captcha/basic_captcha/captcha

响应示例

{
    "success": "success"
}


会员登入

接口描述

URLindex.php?route=account/login/api
功能描述会员登入
返回格式Json,UTF8
HTTP请求方式POST

业务参数

参数名参数全称必选参数类型参数描述
emailemailtrueString邮箱地址
passwordpasswordtrueString密码

返回参数

参数名参数全称必选参数类型参数描述
successsuccesstrueString

调用示例

index.php?route=account/login/api

响应示例

{
    "success": "Login Success",
    "customer": {
        "firstname": "admin",
        "lastname": "test",
        "email": "abc@abc.cn",
        "gender": "F"
    }
}

注销退出

index.php?route=account/logout/api

响应示例

{
    "success": "Logout Success"
}


忘记密码

接口描述

URLindex.php?route=account/forgotten/api
功能描述忘记密码
返回格式Json,UTF8
HTTP请求方式POST

业务参数

参数名参数全称必选参数类型参数描述
emailemailtrueString邮箱地址

返回参数

参数名参数全称必选参数类型参数描述
successsuccesstrueString
warningwarningtrueString错误信息

调用示例

index.php?route=account/forgotten/api

响应示例

{
    "success": "成功 新密码已发送到您的邮箱,请及时查收!"
}


上一篇:解决firefox总是提示flash插件被拦截,要手动点击允许的问题,

下一篇:App加Web项目 Opencart Api接口文档,繁体版

评论列表
发表评论
称呼
邮箱
网址
验证码(*)
热评文章
相关阅读