中文简体    English

IVY云平台账号授权API

版本记录:

1. 简介

WebService API：支持get和post方式调用，所有的请求返回都是json格式数据.

2. IVY云平台API通用示例及说明

2.1 通用示例

WebServiceAPI示例：

• https://{HOST}/gateway?service=xxx.xxx?param1=xxx&param2=xxx

说明:
1.HOST指域名,测试环境域名为test-api.myfoscam.com;
2.Service=xxx.xx,此处指定接口名称;
3.方法主要分为GET 和 POST方法;

返回结果：

{
    "errorCode":"",
    "failureDetails":"",
    "data":""/*如果存在*/
}

a) errorCode为错误码，当返回空字符串时表示成功，其他值时参考对应的api状态码表。
b) failureDetails为错误描述,当错误码不为空时,此字段解释该错误码的含义.
c) data:返回数据,当有返回数据时,数据在此参数中,具体data数据结构见具体的Api接口

2.2 Api相关配置信息说明

2.2.1 Api域名

测试环境: sandboxt-api.ivyiot.io(海外)、test-api.myfoscam.cn(国内)
线上环境: api.myfoscam.com(海外)、api.myfoscam.cn(国内)

2.2.2 重要参数(重要)

云平台内部应用身份信息
clientId:oemkey
clientSecret:397ff5985bb7437198a9ef51b4815caf

用户身份参数(通过密码授权登录接口获得)
openId:用户身份Id
accessToken:用户身份AccessToken

2.3 常见错误码(重要)

2.3.1 系统错误码

系统级错误码,所有接口调用都可能抛出此类错误码;

2.3.2 身份验证错误

需要验证身份的接口,身份信息不正确或者身份信息过期将抛出如下错误

3. Foscam云平台API列表

3.1 账号

3.1.1 账号注册

接口描述:

• 账号注册

请求URL:

• https://{HOST}/gateway?service=user.regist_v2

请求方式:

• POST

请求头:

请求参数:

返回示例:

{
    "errorCode":"",
    "failureDetails":""
}

返回参数说明:

错误码说明:

3.1.2 查询注册国家

接口描述:

• 查询国家列表，用于注册时填写注册国家参数

请求URL:

• https://{HOST}/gateway?service=user.get_regist_country

请求方式:

• GET

请求头:

• 无

请求参数:

• 无

返回示例:

{
    "errorCode":"",
    "data":[
        {
            "code":"US",
            "enName":"America",
            "chName":"美国",
            "zone":"com",
            "area":"NA",
            "selectable":true
        },
        {
            "code":"AR",
            "enName":"Argentina",
            "chName":"阿根廷",
            "zone":"com",
            "area":"SA",
            "selectable":true
        },
        {
            "code":"VN",
            "enName":"Vietnam",
            "chName":"越南",
            "zone":"com",
            "area":"AS",
            "selectable":true
        }
    ]
}

返回参数说明:

错误码说明:

3.1.3 检查账号是否存在并且已经激活

接口描述:

• 检查账号是否存在并且以及激活

请求URL:

• https://{HOST}/gateway?service=user.is_username_exists

请求方式:

• GET

请求头:

• 无

请求参数:

返回示例:

{
    "errorCode":"",
    "data":{
        "yes":true,
        "deviceNum":2,
        "country":"US"
    }
}

返回参数说明:

错误码说明:k

3.1.4 修改密码

接口描述:

• 用户修改密码

请求URL:

• https://{HOST}/gateway?service=user.modify_password

请求方式:

• POST

请求头:

请求参数:

返回示例:

{
    "errorCode":"",
    "failureDetails":""
}

返回参数说明:

错误码说明:

3.1.5 忘记密码-获取重置码Code

接口描述:

• 用户忘记密码，发送重置码至注册邮件

请求URL:

• https://{HOST}/gateway?service=user.gen_resetpwd_code

请求方式:

• POST

请求头:

请求参数:

返回示例:

{
    "errorCode":"",
    "failureDetails":""
}

返回参数说明:

错误码说明:

3.1.6 忘记密码-重置密码

接口描述:

• 忘记密码-账号重置密码

请求URL:

• https://{HOST}/gateway?service=user.resetpwd

请求方式:

• POST

请求头:

请求参数:

返回示例:

{
    "errorCode":"",
    "failureDetails":""
}

返回参数说明:

错误码说明:

3.1.7 忘记密码-查询重置码Code是否有效

接口描述:

• 忘记密码-查询重置码Code是否有效

请求URL:

• https://{HOST}/gateway?service=user.is_resetpwd_code_valid

请求方式:

• GET

请求头:

• 无

请求参数:

返回示例:

{
    "errorCode":"",
    "data":{
        "yes":true
    }
}

返回参数说明:

错误码说明:k

3.1.8 修改密码 - by短信验证码

接口描述:

• 修改密码 通过短信验证码, 短信验证码App本地进行校验

请求URL:

• https://{HOST}/gateway?service=user.reset_pwd_by_sms

请求方式:

• POST

请求头:

• 无

请求参数:

返回示例:

{
    "errorCode":"",
    "data":{

    }
}

返回参数说明:

错误码说明:k

3.1.9 获取账号信息

接口描述:

• 获取账号信息

请求URL:

• https://{HOST}/gateway?service=user.get_user_info

请求方式:

• GET

请求头:

• 无

请求参数:

返回示例:

{
    "errorCode":"",
    "data":{
        "id":111111,
        "username":"xxxxxx@xxx.com",
        "name":"xxxxxxxx",
        "nickname":"yyyyyyyy",
        "gender":2,
        "birthday":"1970-01-01",
        "phoneNo":"0755-8888888",
        "mobilePhoneNo":"13888888888",
        "country":"US",
        "ipCountry":"CN",
        "area":"NA",
        "ctime":1522567864000,
        "updateTime":1561021443000,
        "status":1,
        "type":0,
        "generalUserage":7,
        "otherUserage":"YYYYYY",
        "accessType":1,
        "betaStatus":1,
        "subscribeEdm":2
    }
}

返回参数说明:

错误码说明:k

3.1.10 修改用户信息

接口描述:

• 修改用户信息

请求URL:

• https://{HOST}/gateway?service=user.modify_user_info

请求方式:

• POST

请求头:

请求参数:

返回示例:

{
    "errorCode":"",
    "failureDetails":""
}

返回参数说明:

错误码说明:

3.2 授权登陆

3.2.1 用户密码授权（登录）

接口描述:

• 登录获取clientId和accessToken等重要身份信息

请求URL:

• https://{HOST}/gateway?service=oauth.authorize

请求方式:

• POST

请求头:

请求参数:

返回示例:

{
    "errorCode":"",
    "failureDetails":"",
    "data":{
        "openId":"",
        "accessToken":"",
        "refreshToken":"",
        "expiresIn":123456,
        "username":"username",
        "userId":111111,
        "country":"US",
        "betaStatus":1
    }
}

返回参数说明:

错误码说明:

3.2.2 身份验证

接口描述:

• 验证身份信息,需要的验证身份参数通过用户密码授权接口获取

请求URL:

• https://{HOST}/gateway?service=oauth.is_accesstoken_valid

请求方式:

• POST

请求头:

请求参数:

返回示例:

{
    "errorCode":"",
    "failureDetails":"",
    "data":{
        "yes":true
    }
}

返回参数说明:

错误码说明:

3.2.3 账号注销(退出登录or切换账号)

接口描述:

• 注销退出当前账号

请求URL:

• https://{HOST}/gateway?service=oauth.invalid_access_token

请求方式:

• POST

请求头:

请求参数:

返回示例:

{
    "errorCode":"",
    "failureDetails":"",
    "data":{
        "yes":true
    }
}

返回参数说明:

错误码说明: