1、API List

This section contains the API used for third-party customers integrate DDNS functionality.

See the following list：

1.1. Get access token

• Function

  Provide a neutral login web page: https://openauth.ezvizlife.com/oauth/ddns/{appKey}?areaId={areaId}&response_type={response_type}&client_type={client_type}&bundleId={bundleId}, and use the browser to open the web page.

• Return

  https://isgpopenauth.ezvizlife.com/oauth/success#access_token=at.6lou7gyz7aum2mae4t1kenm56tbrnczk-4u8bktfgp7-0ooek8c-y7bniu7zf&expires_in=1525240569675&scope=basic&state=xxx&refresh_token=rt.79d7kasdsafdedyjq7thpcud61e9s-8kzdr8korq-0s0lf7f-5zonugnfv&open_id=fd0casdasd4df1846c5c80d11f01e1&areaDomain=https://isgpopen.ezvizlife.com&authDomain=https://isgpopenauth.ezvizlife.com

1.2. Get access token via appKey and secret

• API Function

  This API is used for the admin user to get the access token。

• Request Address

  https://open.ezvizlife.com/api/lapp/token/get

• Request Type

  POST

• Request Parameters

• HTTP Request Message

POST /api/lapp/token/get HTTP/1.1
Host: open.ezvizlife.com
Content-Type: application/x-www-form-urlencoded

appKey=9mqitppidgce4y8n54ranvyqc9fjtsrl&appSecret=096e76501644989b63ba0016ec5776

• Return Data

{
    "data": {
        "accessToken": "at.1b1cg2im66fnsj91090hvhbk43zmnkeh-22yjlfyvm4-0eyh0pl-alewra6g0",
        "expireTime": 1470810222045,
        "areaDomain": "https://iusopen.ezvizlife.com"
    },
    "code": "200",
    "msg": "操作成功!"
}

• Return Field

• Return Code

1.3. Refresh access token

• API Function

  This API is used for the user to reresh the access token。

• Request Address

  {authDomain}/oauth/token/refreshToken

  authDomain is get from Get access token,

• Request Type

  POST

• Request Parameters

openId and refresh_token get from Get access token

• HTTP Request Message

POST /oauth/token/refreshToken HTTP/1.1
Host: isgpopenauth.ezvizlife.com
Content-Type: application/x-www-form-urlencoded

refresh_token=rt.8n061upasdaadgcw5jb7ixrxn9-1e7un1xwb4-0e7ubbk-1xaz7zsg1&client_id=ae1b9aasdaasdab88da6dbbf2dd8d5&grant_type=refresh_token&open_id=183dasdasd9ab97410c4ffeaa28&scope=xxx&state=xx

• Return Data

{
    "code":"200",
    "msg":"Operate succeeded!",
    "data":{
        "expires_in": 1513864879148,
        "scope": "basic",
        "openId":"sadfasdfadsfa",
        "refresh_token": "rt.8n061up7c9end2asdasdasdasxn9-1e7un1xwb4-0e7ubbk-1xaz7zsg1",
        "access_token": "at.6rx47zjfa0idqthh6463h5mvdmcaqck5-1hpgib6dd8-0sxfvyq-fj8sask8a",
        "state":"xxx"
    }
}

• Return Field

RefreshToken Object:

• Return Code

1.4. Get device DDNS information

• Function

  This API is used to get the device DDNS information, including the shared device DDNS information.

• Request Address

  {areaDomain}/api/lapp/ddns/get

• Request Method

  POST

• Request Parameters

• HTTP Request Report

POST /api/lapp/ddns/get HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.1b1cg2im66fnsj91090hvhbk43zmnkeh-22yjlfyvm4-0eyh0pl-alewra6g0&deviceSerial=519928976

• Return Data

{
    "data": {
        "upnpMappingMode": 0,
        "domain": "test123456",
        "hiddnsHttpPort": 0,
        "mappingHiddnsHttpPort": 81,
        "hiddnsHttpsPort": 0,
        "hiddnsCmdPort": 0,
        "mappingHiddnsCmdPort": 80,
        "hiddnsRtspPort": 0,
        "deviceIp": "212.140.29.17",
        "subSerial": "704122511",
        "serial": "CS-C13-31WFR0120170112AACC704122511",
        "deviceName": "C2C(704122511)"
    },
    "code": "200",
    "msg": "操作成功!"
}

• Return Filed

HiddnsDeviceInfo Object:

• Return Code

1.5. Set device DDNS domain

• Function

  This API is used to set the device DDNS domain, including the shared device's DDNS domain.

• Request Address

  {areaDomain}/api/lapp/ddns/setDomain

• Request Method

  POST

• Request Parameters

• HTTP Request Report

POST /api/lapp/ddns/setDomain HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.1b1cg2im66fnsj91090hvhbk43zmnkeh-22yjlfyvm4-0eyh0pl-alewra6g0&deviceSerial=519928976&domain=519928976

• Return Data

{
  "code": "200",
  "msg": "操作成功!"
}

• Return Filed

• Return Code

1.6. Set device DDNS auto mapping

• Function

  Set device DDNS auto mapping mode by single device.

• Request Address

  {areaDomain}/api/lapp/ddns/mode/setAutomatic

• Request Method

  POST

• Request Parameters

• HTTP Request Report

POST /api/lapp/ddns/mode/setAutomatic HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.1b1cg2im66fnsj91090hvhbk43zmnkeh-22yjlfyvm4-0eyh0pl-alewra6g0&deviceSerial=519928976

• Return Data

{
  "code": "200",
  "msg": "操作成功!"
}

• Return Filed

• Return Code

1.7. Set device DDNS manual mapping

• Function

  Set device DDNS manual mapping mode by single device.

• Request Address

  {areaDomain}/api/lapp/ddns/mode/setManual

• Request Method

  POST

• Request Parameters

• HTTP Request Report

POST /api/lapp/ddns/mode/setManual HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.1b1cg2im66fnsj91090hvhbk43zmnkeh-22yjlfyvm4-0eyh0pl-alewra6g0&deviceSerial=519928976&cmdPort=80&httpPort=81

• Return Data

{
  "code": "200",
  "msg": "操作成功!"
}

• Return Filed

• Return Code

1.8. Get DDNS information of all the devices in the account

• Function

  Turn page (the maximum device number on each page is 50) to get the DDNS information of all the devices (including shared devices) in the current account.

• Request Address

  {areaDomain}/api/lapp/ddns/list

• Request Method

  POST

• Request Parameters

• HTTP Request Report

POST /api/lapp/ddns/list HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.1b1cg2im66fnsj91090hvhbk43zmnkeh-22yjlfyvm4-0eyh0pl-alewra6g0&pageSize=10&pageStart=0

• Return Data

{
    "page":{
        "total":1,
        "page":0,
        "size":1
    },
    "data":[
        {
            "upnpMappingMode": 0,
            "domain": "test123456",
            "hiddnsHttpPort": 0,
            "mappingHiddnsHttpPort": 81,
            "hiddnsHttpsPort": 0,
            "hiddnsCmdPort": 0,
            "mappingHiddnsCmdPort": 80,
            "hiddnsRtspPort": 0,
            "deviceIp": "212.140.29.17",
            "subSerial": "704122511",
            "serial": "CS-C13-31WFR0120170112AACC704122511",
            "deviceName": "C2C(704122511)"
        }
    ],
    "code":"200",
    "msg":"操作成功!"
}

• Return Filed

HiddnsDeviceInfo Object:

Page Object:

• Return Code

1.9. Share device DDNS information

• Function

  Share DDNS information to other account by single device.

• Request Address

  {areaDomain}/api/lapp/ddns/share

• Request Method

  POST

• Request Parameters

• HTTP Request Report

POST /api/lapp/ddns/share HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.1b1cg2im66fnsj91090hvhbk43zmnkeh-22yjlfyvm4-0eyh0pl-alewra6g0&deviceSerial=519928976&account=following1998%40126.com

• Return Data

{
  "code": "200",
  "msg": "操作成功!"
}

• Return Filed

• Return Code

1.10. Add Device

• Function

  Add device to this account.

• Request Address

  {areaDomain}/api/lapp/device/add

• Request Method

  POST

• Request Parameters

• HTTP Request Report

POST /api/lapp/device/add HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.20h863523v1zfck75qgmwhoy7vl2teqp&deviceSerial=427734888&validateCode=ABCDEF

• Return Data

{
  "code": "200",
  "msg": "操作成功!"
}

• Return Filed

• Return Code

1.11. Get DDNS information of all the shared devices in the account

• Function

  Turn page (the maximum device number on each page is 50) to get the DDNS information of all the shared devices in the current account.

• Request Address

  {areaDomain}/api/lapp/ddns/share/list

• Request Method

  POST

• Request Parameters

• HTTP Request Report

POST /api/lapp/ddns/share/list HTTP/1.1
Host: isgpopen.ezvizlife.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.1b1cg2im66fnsj91090hvhbk43zmnkeh-22yjlfyvm4-0eyh0pl-alewra6g0&pageSize=10&pageStart=0

• Return Data

{
    "page":{
        "total":1,
        "page":0,
        "size":1
    },
    "data":[
        {
            "upnpMappingMode": 0,
            "domain": "test123456",
            "hiddnsHttpPort": 0,
            "mappingHiddnsHttpPort": 81,
            "hiddnsHttpsPort": 0,
            "hiddnsCmdPort": 0,
            "mappingHiddnsCmdPort": 80,
            "hiddnsRtspPort": 0,
            "deviceIp": "212.140.29.17",
            "subSerial": "704122511",
            "serial": "CS-C13-31WFR0120170112AACC704122511",
            "deviceName": "C2C(704122511)"
        }
    ],
    "code":"200",
    "msg":"操作成功!"
}

• Return Filed

HiddnsDeviceInfo Object:

Page Object:

• Return Code

1.12. Get area list of all the nations

• Function

  Get area list of all the nations.

• Request Address

  https://open.ezvizlife.com/api/lapp/area/list

• Request Method

  GET, POST

• HTTP Request Report

GET /api/lapp/area/list HTTP/1.1
Host: open.ezvizlife.com

• Return Data

{
    "data": [
        {
            "id": 101,
            "name": "Andorra",
            "region": "Europe",
            "telephoneCode": 376
        },
        {
            "id": 102,
            "name": "Austria",
            "region": "Europe",
            "telephoneCode": 43
        }
    ],
    "code": "200",
    "msg":"操作成功!"
}

• Return Filed