中文简体    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指域名,测试环境域名为sandboxt-web.ivyiot.io;
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_ipc_setting_v2_0.addOemDevice

请求方式:

• POST

请求头:

请求参数:

返回示例:

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

返回参数说明:

错误码说明:

3.1.2 删除设备

接口描述:

• 删除用户设备

请求URL:

• https://{host}/gateway?service=user_ipc_setting_v2_0.delOemDeviceByMac

请求方式:

• POST

请求头:

请求参数:

返回示例:

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

返回参数说明:

错误码说明:

3.1.3 修改设备

接口描述:

• 修改设备

请求URL:

• https://{host}/gateway?service=user_ipc_setting_v2_0.updateOemDevice

请求方式:

• POST

请求头:

请求参数:

返回示例:

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

返回参数说明:

错误码说明:

3.1.4 查询用户设备

接口描述:

• 查询用户所属的设备信息

请求URL:

• https://{host}/gateway?service=user_ipc_setting_v2_0.getOemDeviceByUser

请求方式:

• GET

请求头:

• 无 |

请求参数:

返回示例:

{
    "errorCode":"",
    "data":[
        {
            "userId":622258,
            "macAddr":"macAddr",
            "deviceName":"deviceName",
            "productName":"productName",
            "username":"asd",
            "password":"password",
            "hasusertag":1,
            "supportStore":1,
            "supportRichMedia":1,
            "oemCode":"7128"
        },
        {
            "userId":622258,
            "macAddr":"macAddr3",
            "deviceName":"deviceName1",
            "productName":"productName",
            "username":"username1",
            "password":"password1",
            "hasusertag":1,
            "supportStore":0,
            "supportRichMedia":0,
            "oemCode":"7128"
        }
    ]
}

返回参数说明:

错误码说明:

3.1.5 根据mac查询设备

接口描述:

• 通过mac地址查询设备信息

请求URL:

• https://{host}/gateway?service=user_ipc_setting_v2_0.getOemDeviceByUserAndMac

请求方式:

• GET

请求头:

• 无 |

请求参数:

返回示例:

{
    "errorCode":"",
    "data":{
        "userId":622258,
        "macAddr":"macAddr",
        "deviceName":"deviceName",
        "productName":"productName",
        "username":"asd",
        "password":"password",
        "hasusertag":1,
        "supportStore":1,
        "supportRichMedia":1,
        "oemCode":"7128"
    }
}

返回参数说明:

错误码说明:

3.1.6 解绑设备

接口描述:

• 通过mac及验签对设备进行解绑操作

请求URL:

• https://{host}/gateway?service=user_ipc_setting_v2_0.delOemDeviceForce

请求方式:

• POST

请求头:

• 无 |

请求参数:

返回示例:

{
    "errorCode":""
}

返回参数说明:

错误码说明:

3.2 服务激活与授权

3.2.1 查询用户未激活授权记录

接口描述:

• 查询用户所有未激活的授权记录

请求URL:

• https://{HOST}/gateway?service=permission.query_user_not_active

请求方式:

• GET

请求头:

• 无

请求参数:

返回示例:

{
    "errorCode":"",
    "data":[
        {
            "grantId":222222,
            "ipcMac":"ipcMac",
            "permissionCode":"permissionCode",
            "permissionName":"permissionName",
            "permissionType":1,
            "permissionValue":0,
            "grantStatus":1,
            "userTag":"userTag",
            "streamId":"streamId",
            "belongServer":"belongServer",
            "initTime":1565847960000,
            "channelCount":0
        },
        {
            "grantId":111111,
            "ipcMac":"ipcMac",
            "permissionCode":"permissionCode",
            "permissionName":"permissionName",
            "permissionType":1,
            "permissionValue":0,
            "grantStatus":1,
            "userTag":"userTag",
            "belongServer":"belongServer",
            "initTime":1565847960000,
            "channelCount":0
        }
    ],
    "sysDate":1576289329443
}

返回参数说明:

错误码说明:

3.2.2 激活权限

接口描述:

• 激活设备单个权限

请求URL:

• https://{HOST}/gateway?service=permission.active

请求方式:

• POST

请求头:

请求参数:

返回示例:

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

返回参数说明:

错误码说明:

3.2.3 获取用户设备当前服务信息

接口描述:

• 获取用户设备当前服务信息

请求URL:

• https://{HOST}/gateway?service=fcmall.get_current_service

请求方式:

• GET

请求头:

• 无

请求参数:

返回示例:

{
    "errorCode":"",
    "data":{
        "userId":111111,
        "macAddr":"macAddr",
        "name":"3 days per year",
        "description":"3 Day Cloud Storage",
        "startTime":1521093393000,
        "endTime":1552629393000,
        "validity":"12 Months",
        "status":3,
        "flag":1
    }
}

返回参数说明:

错误码说明:

3.2.4 查询用户所有设备的有效的的授权记录

接口描述:

• 查询用户所有设备的有效的的授权记录

请求URL:

• https://{HOST}/gateway?service=permission.query_user_ipcs_valid

请求方式:

• GET

请求头:

• 无

请求参数:

返回示例:

{
    "errorCode":"",
    "data":[
        {
            "grantId":222222,
            "ipcMac":"ipcMac",
            "permissionCode":"permissionCode",
            "permissionName":"permissionName",
            "permissionType":1,
            "permissionValue":0,
            "grantStatus":1,
            "userTag":"userTag",
            "streamId":"streamId",
            "belongServer":"belongServer",
            "initTime":1565847960000,
            "channelCount":0
        },
        {
            "grantId":111111,
            "ipcMac":"ipcMac",
            "permissionCode":"permissionCode",
            "permissionName":"permissionName",
            "permissionType":1,
            "permissionValue":0,
            "grantStatus":1,
            "userTag":"userTag",
            "belongServer":"belongServer",
            "initTime":1565847960000,
            "channelCount":0
        }
    ],
    "sysDate":1576289329443
}

返回参数说明:

错误码说明:

3.3 云存储与直播

3.3.1 基础子服务信息查询

接口描述:

• 查询用户子服务信息,对于一个用户所返回的数据是固定的,用户只要查询一次即可

请求URL:

• https://{HOST}/gateway?service=center.getServerInfo

请求方式:

• GET

请求头:

• 无

请求参数:

返回示例:

{
    "errorCode":"",
    "data":{
        "userId":111111,
        "subtoken":"subtoken",
        "area":"NA",
        "tag":"tag",
        "storeTag":"storeTag",
        "alexaTag":"alexaTag",
        "sendMsgUrl":"sendMsgUrl",
        "sendMsgUrlSecure":"sendMsgUrlSecure",
        "url":"url",
        "storeUrl":"storeUrl",
        "alexaUrl":"alexaUrl",
        "channelCount":0
    }
}

返回参数说明:

错误码说明:

3.3.2 APP查询存在录像日期列表

接口描述:

• App查询设备存在录像的时间, 此处HOST是基础子服务信息查询接口结果中的storeUrl地址;

请求URL:

• https://{HOST}/stream?service=record.date.query

请求方式:

• GET

请求头:

• 无

请求参数:

返回示例:

{
    "dateList":[
        "20190330T190000",
        "20190331T210000",
        "20190331T190000",
        "20190330T220000",
        "20190331T000000",
        "20190401T180000",
        "20190401T000000"
    ],
    "errorCode":"",
    "failureDetails":""
}

返回参数说明:

3.3.3 APP获取录像时间

接口描述:

• App通过起止时间获取该时间段内的所有视频片段的起止时间,此处HOST是基础子服务信息查询接口结果中的storeUrl地址;;

请求URL:

• https://{HOST}/stream?service=record.query

请求方式:

• GET

请求头:

• 无

请求参数:

返回示例:

{
    "errorCode":"",
    "failureDetails":"",
    "recordList":[
        [
            "1554160661",
            "1554160702",
            "2"
        ],
        [
            "1554160794",
            "1554160913",
            "2"
        ],
        [
            "1554161090",
            "1554161145",
            "2"
        ],
        [
            "1554161801",
            "1554161851",
            "2"
        ],
        [
            "1554162015",
            "1554162054",
            "2"
        ],
        [
            "1554162067",
            "1554162129",
            "2"
        ]
    ]
}

返回参数说明:

错误码说明:

3.3.4 App获取播放录像地址

接口描述:

• App获取录像地址,此处HOST是基础子服务信息查询接口结果中的storeUrl地址;;

请求URL:

• https://{HOST}/ stream?service=record.play

请求方式:

• GET

请求头:

• 无

请求参数:

返回示例:

{
    "errorCode":"",
    "failureDetails":"",
    "recordUrl":"http://plb-test.myfoscam.com:8100/hls/362d96836ef005eee0460033724fd26c6164406E4B7E409D8E/2019/03/12/718a9039b6b56451_155341.m3u8?timerange=1552377221-1552377230&expires=1552381960&urlVersion=&sign=544ff805a697a373f65c603987db2404&storageType=BPI&oemCode=",
    "secureUrl":"https://plb-test.myfoscam.com:443/hls/362d96836ef005eee0460033724fd26c6164406E4B7E409D8E/2019/03/12/718a9039b6b56451_155341.m3u8?timerange=1552377221-1552377230&expires=1552381960&urlVersion=&sign=544ff805a697a373f65c603987db2404&storageType=BPI&oemCode=&se=1"
}

返回参数说明:

错误码说明:

3.4 其他

3.4.1 服务器时间查询

接口描述:

• 爱为服务器时间查询

请求URL:

• https://{HOST}/gateway?service=cloud_system.current_time

请求方式:

• GET

请求头:

• 无

请求参数:

• 无

返回示例:

{
    "errorCode":"",
    "data":1576481002262
}

返回参数说明:

错误码说明:

3.5 固件升级

3.5.1 根据机型名称获取最新版本固件（IPC）

接口描述:

• 根据机型名称获取最新版本固件

请求URL:

• https://{HOST}/gateway?service=firmware.latest

请求方式:

• GET

请求头:

• 无

请求参数:

返回示例:

{
    "errorCode":"",
    "firmwareList":[
        {
            "id":135,
            "name":"FosIPC_J_app_ver2.x.2.77MZS4010",
            "desc":"{"zh":"FosIPC_J_app_ver2.x.2.77MZS4010"}",
            "uploadUtilName":"aws-s3",
            "backupUploadUtilName":"local-disk",
            "path":"/firmware/test/FosIPC_J_app_ver2.x.2.77MZS4010--1576569091241.bin",
            "downloadUri":"http://test-download.myfoscam.com:9001/firmware/test/FosIPC_J_app_ver2.x.2.77MZS4010--1576569091241.bin",
            "backupUri":"http://test-download.myfoscam.com:9001/firmware/test/FosIPC_J_app_ver2.x.2.77MZS4010--1576569091241.bin",
            "md5":"24AD9165B11ECB633901BC7F3B412D7F",
            "type":2,
            "interim":false,
            "version1":2,
            "version2":"x",
            "version3":2,
            "version4":77,
            "patchVersion":0,
            "createTime":1576569118000,
            "seqNo":4,
            "newest":true,
            "active":true,
            "remind":1,
            "remindActive":false,
            "firmwarePlatform":"Mstar",
            "productTypeId":1,
            "winPluginId":176,
            "macOsPluginId":177
        }
    ],
    "remind":1
}

返回参数说明:

错误码说明: