Stc 接口
[说明] STC相关接口
[属性] 专用接口
Location 接口
[说明] 位置相关接口,包括 最后位置,轨迹等
[属性] 通用接口
| API | Description |
|---|---|
| POST api/Location/Tracking |
Get real time tracking data for a device |
| POST api/Location/History |
Get history location data for a device in a time range |
| POST api/Location/NewsHistory |
Get history location data for a device in a time range |
| POST api/Location/SaveBbs |
宠物公告 |
| POST api/Location/Address |
Convert the lat/lng to address, this is only work in China now, consult for engineer to support other countries |
| POST api/Location/MonthHistoryDays |
获取指定月份中设备在哪些天有轨迹数据 |
| OPTIONS api/Location/Options |
No documentation available. |
Geofence 接口
[说明] 电子围栏相关接口
[属性] 通用接口
| API | Description |
|---|---|
| POST api/Geofence/CreateGeofence |
Create a new Geofence for a device |
| POST api/Geofence/EditGeofence |
Edit an exists geofence |
| POST api/Geofence/DeleteGeofence |
Delete a geofence |
| POST api/Geofence/GeofenceList |
Get geofence list of a specific device |
| POST api/Geofence/GeofenceByFenceId |
Get geofence list of a specific device |
| POST api/Geofence/ChangeFenceStatus |
修改围栏使用状态 |
| OPTIONS api/Geofence/Options |
No documentation available. |
Contact 接口
联系人
| API | Description |
|---|---|
| POST api/Contact/AddContact |
保存联系人 |
| POST api/Contact/DelContact |
删除联系人 |
| POST api/Contact/GetContactsList |
获取联系人列表 |
| POST api/Contact/GetContactsListByLeYuan |
获取联系人列表(乐源) |
WhiteList 接口
[说明] 白名单设置接口
[属性] 通用接口
| API | Description |
|---|---|
| POST api/WhiteList/setBindNum |
设置号码绑定关系 |
| POST api/WhiteList/UserToDeviceClickToDial |
用户拨打设备号码 |
Files 接口
[说明] 文件相关接口
[属性] 通用接口
| API | Description |
|---|---|
| POST api/Files/UpdateFileForRead |
文件标识为已读 常用于语音聊天等 |
| POST api/Files/GetPicture |
获取设备上上传的图片 |
| POST api/Files/FileListByTime |
按时间获取文件列表,并按日期分组返回 |
| POST api/Files/ZcChatList |
聊天信息列表获取,分页形式 [专用接口] |
| POST api/Files/ZcChatUpload |
聊天信息提交服务器 [专用接口] |
| POST api/Files/NewVoiceUpload |
语音聊天提交服务器 |
| POST api/Files/TextExpressionUpload |
文本或表情聊天提交服务器(乐源) |
| POST api/Files/VoiceUpload |
语音聊天提交服务器 |
| POST api/Files/NewVoiceFileListByTime |
通过用户获取语音聊天记录 |
| POST api/Files/VoiceFileListByTime |
通过用户获取语音聊天记录 |
| POST api/Files/VoiceFileListByDelTime |
通过用户获取语音聊天记录过滤时间(乐源) |
| POST api/Files/GetVoice |
获取单个语音信息 |
| POST api/Files/VoiceFileListNoRead |
按天返回查找未读语音记录 |
| POST api/Files/DeleteFileByIds |
删除文件(语音或图片) |
| POST api/Files/DelFileAllByImei |
文件标识为已读 常用于语音聊天等 |
| POST api/Files/PostFile | |
| POST api/Files/UrlVoiceUpload |
语音提交服务器。返产生URL下发给设备 |
ExcellentSchool 接口
[说明] 用户相关接口
[属性] 通用接口
| API | Description |
|---|---|
| POST api/ExcellentSchool/Login |
Login by user name and password |
| POST api/ExcellentSchool/RegisterNeedSMSCode |
注册用户通过短信验证 |
| POST api/ExcellentSchool/CheckUser |
Check username is exists or not |
| POST api/ExcellentSchool/ChangePasswordNeedSMSCode |
修改密码通过短信验证码 |
| POST api/ExcellentSchool/AddDeviceAndUserGroup |
添加设备同时建立默认家庭成员分组[手表] |
| POST api/ExcellentSchool/SendSmsValidateCode |
短信方式下发验证码给手表 [专用接口] |
| POST api/ExcellentSchool/SendSMSCode |
以短信方式发送注册验证码 |
ThirdParty 接口
[说明] 第三方登录相关,目前暂未使用
[属性] 通用接口
| API | Description |
|---|---|
| POST api/ThirdParty/ValidateThird |
第三方登录信息 |
| POST api/ThirdParty/BindThirdParty |
绑定第三方登录 |
| POST api/ThirdParty/UnBindThirdParty |
解除第三方登录绑定 |
Group 接口
[说明] 分组相关接口
[属性] 通用接口
| API | Description |
|---|---|
| POST api/Group/AddGroup |
添加一个分组 [车机] |
| POST api/Group/GroupList |
获取账号分组列表 [车机] |
| POST api/Group/SaveUserGroup |
添加分组或角色 [手表] |
| POST api/Group/UesrDefaultGroupList |
获取用户的分组和角色 [手表] |
| POST api/Group/UesrGroupList |
获取用户的分组和角色 [手表] |
| OPTIONS api/Group/Options |
No documentation available. |
| POST api/Group/UserGroupNoDefault |
没有默认分组的用户分组 大分组默认为监护人 [手表] |
| POST api/Group/EditUserGroup |
编辑分组信息 [手表] |
Device 接口
[说明] 设备相关接口
[属性] 通用接口
Watch 接口
手表接口【用于手表设备】
| API | Description |
|---|---|
| POST api/Watch/Position |
上传位置 |
CarMaintain 接口
[说明] 车辆保养相关接口
[属性] 车机设备接口
| API | Description |
|---|---|
| POST api/CarMaintain/MaintainSetting |
车辆保养设置 |
| POST api/CarMaintain/MaintainInfo |
车辆保养信息 |
| POST api/CarMaintain/MaintainList |
车辆保养记录 |
| POST api/CarMaintain/MaintainTypeList |
保养项目列表 |
| POST api/CarMaintain/SaveMaintain |
添加保养记录 |
| OPTIONS api/CarMaintain/Options |
Person 接口
[说明] 设备人员信息相关接口
人员头像 avatar字段,若有图片上传,请使用base64字符串赋值
[属性] 手表接口
| API | Description |
|---|---|
| POST api/Person/SavePersonProfile |
保存手表相关对象(人员)信息 [手表] |
| POST api/Person/GetPersonProfile |
获取设备相关对象(人员)信息 [手表] |
| POST api/Person/PersonPhotoAndName |
用户注册获取注册信息 [手表] |
| POST api/Person/SaveDeviceMaster |
保存用户信息 [专用接口] |
| POST api/Person/DeviceMasterInfo |
获取用户信息 [专用接口] |
Order 接口
[说明] 产品信息
[属性] 通用接口
| API | Description |
|---|---|
| POST api/Order/GetOrderByAppId |
查询订单 |
Values 接口
| API | Description |
|---|---|
| GET api/Values/Get |
No documentation available. |
| GET api/Values/Get/{id} |
No documentation available. |
| POST api/Values/Post |
No documentation available. |
| PUT api/Values/Put/{id} |
No documentation available. |
| DELETE api/Values/Delete/{id} |
No documentation available. |
| OPTIONS api/Values/Options |
No documentation available. |
DataList 接口
[说明] 公共字典信息相关接口
[属性] 通用接口
| API | Description |
|---|---|
| POST api/DataList/TimeZoneList |
时区列表获取接口 |
| POST api/DataList/LanguageList |
语言列表 |
Payment 接口
[说明] 产品信息
[属性] 通用接口
| API | Description |
|---|---|
| POST api/Payment/PostPayment |
统一下单 |
APPInfo 接口
[说明] APP相关信息接口
[适用] 适用APP相关信息
[条件] 此接口需服务器相关配置。
[属性] 专用定制接口
| API | Description |
|---|---|
| POST api/APPInfo/CheckVersion |
检查是否有新版本 |
| POST api/APPInfo/NewsCheckVersion |
检查是否有新版本 |
Controller 接口
[说明] 信息更新接口
[属性] 特定设备专用接口
| API | Description |
|---|---|
| POST api/Controller/Update |
No documentation available. |
ExceptionMessage 接口
[说明] 设备报警相关接口
[属性] 通用接口
CarCheck 接口
[说明] 车辆年审记录相关接口
[属性] 车机设备接口
| API | Description |
|---|---|
| POST api/CarCheck/CarCheckSetting |
年审设置接口 |
| POST api/CarCheck/SaveCarCheck |
添加年审信息接口 |
| POST api/CarCheck/CarCheckInfo |
车辆年审信息 |
| POST api/CarCheck/CarCheckList |
年审记录列表 |
CarBrand 接口
[说明] 车辆品牌接口
[属性] 车机设备接口
| API | Description |
|---|---|
| POST api/CarBrand/MktBrandList |
适用于 VT200(MKT) obd 车型列表 |
| POST api/CarBrand/CarBrandList |
车辆品牌列表 |
| POST api/CarBrand/CarSeriesList |
车系列表,根据品牌查询品牌下面的车系 |
| POST api/CarBrand/CarModelsList |
车型列表,根据车系获取 |
| OPTIONS api/CarBrand/Options |
Dance 接口
[说明] 舞蹈控制器(舞蹈队创建,舞蹈队添加成员,自己的队伍列表,排行(跳舞排行))
[属性] 通用接口
| API | Description |
|---|---|
| POST api/Dance/CheckDanceTeamInfo |
检查该设备是否在领队里存在 |
| POST api/Dance/SavaDanceTeamInfo |
创建舞蹈队伍信息 |
| POST api/Dance/SavaDanceMemberInfo |
新增舞蹈成员信息 |
| POST api/Dance/SavaDeviceFriends |
新增设备好友 |
| POST api/Dance/GetMyTeam |
自己的队伍 |
| POST api/Dance/RemoverDanceTeam |
删除舞蹈队 |
| POST api/Dance/Ranking |
排行 |
| POST api/Dance/GetStep |
获取好友计步 |
| POST api/Dance/CheckUser |
检查用户名是否存在 |
| POST api/Dance/DelDanceMemberInfo |
删除成员 |
| POST api/Dance/GetChinaGuardian |
获取监护人数据 |
| POST api/Dance/ChangePassword |
修改密码 |
| POST api/Dance/SavaGuardian |
同步监护人数据 |
PositionInfoCollect 接口
[说明] 数据采集相关接口
[属性] 通用接口
| API | Description |
|---|---|
| POST api/PositionInfoCollect/LBSCollect |
LBS信息收集 |
| POST api/PositionInfoCollect/WIFICollect |
Wifi信息收集 |
AuthShare 接口
[说明] 申请分享设备相关API接口
[属性] 个人设备接口
| API | Description |
|---|---|
| POST api/AuthShare/UserRequest |
申请分享请求 |
| POST api/AuthShare/UserRequestAndGrouping |
用户分享添加至相关分组 |
| POST api/AuthShare/Process |
处理分享请求 |
| POST api/AuthShare/RequestList |
请求分享列表 |
| POST api/AuthShare/ShareList |
监护人列表 |
| POST api/AuthShare/RemoveShare |
删除分享,以及解绑 H5和APP解绑设备调用 |
| POST api/AuthShare/UpdateRelationName |
修改关系名称 |
Weather 接口
[说明] 天气接口
[属性] 通用接口
| API | Description |
|---|---|
| POST api/Weather/GetWeather |
获取天气信息 |
NewsInformation 接口
| API | Description |
|---|---|
| POST api/NewsInformation/GInformationList |
根据参数来查询资讯列表 |
| POST api/NewsInformation/GNewsListHFive |
根据参数来查询资讯列表(H5专用) |
| POST api/NewsInformation/InformationList |
根据参数来查询资讯列表 |
| POST api/NewsInformation/GInformationById?postId={postId} |
根据id去查询资讯详情 |
User 接口
[说明] 用户相关接口
[属性] 通用接口
Amazon 接口
[说明] 亚马逊推送相关注册
[适用] 适用于需亚马逊推送的群体
[条件] 此接口需服务器配置亚马逊推送才可使用。
[属性] 通用接口
| API | Description |
|---|---|
| POST api/Amazon/AmazonRegister |
向亚马逊推送注册手机 |
| POST api/Amazon/RemoveEndpointArn |
从亚马逊推送删除设备注册 |
| POST api/Amazon/ClearExpireEndpointArn?EndpointArn={EndpointArn} |
清理已过期的arn |
| GET api/Amazon/GetEndpointArnAttr?EndpoinArn={EndpoinArn} |
获取arn 附加信息 |
| POST api/Amazon/SetEndpointArnAttr?EndpoinArn={EndpoinArn} |
设置arn附加信息 |
| POST api/Amazon/UpdateArnAttr?arn={arn}&enabled={enabled} |
更新arn附加信息 |
Test 接口
| API | Description |
|---|---|
| POST api/Test/HealthInfo |
获取个人设备的计步,心率等信息 |
Health 接口
[说明] 健康功能接口
包含:计步,心率,血压,血氧,睡眠等和健康相关数据
[属性] 手表接口
| API | Description |
|---|---|
| POST api/Health/GetHealthForDay |
查询某天的步数总和 [手表] |
| POST api/Health/GetStepsForDay |
计算一段时间内,每天的步数 [手表] |
| POST api/Health/GetStepsForHour |
计算某天每小时的步数值 [手表] |
| POST api/Health/SetHealthInfoConfig |
保存设置健康配置 |
| POST api/Health/GetHealthInfoConfig |
获取设置健康配置 |
| POST api/Health/GetHealthForPeriod |
统计某时间段的步数 |
| POST api/Health/GetHealth |
查询某时间段的健康数据 包括心跳 血压 体温 步数等 [手表] |
| POST api/Health/GetSleepData |
获取睡眠数据 [手表] |
| POST api/Health/GetHealthByType |
获取心率或血压数据 |
| POST api/Health/GetJxSleepLastData |
获取JxSleep(最后数据) |
| POST api/Health/GetJxSleepLastDataByDate |
获取JxSleep(历史数据) |
| POST api/Health/GetJxSleepData |
获取JxSleep(周,月历史数据) |
| POST api/Health/GetHealthByTypeLastData |
获取心率或血压数据(最后数据) |
| POST api/Health/UploadStepData |
上传步数 [手环] |
| POST api/Health/StepRankingList |
步数排行榜 [手环] |
| POST api/Health/UserStepRankingInfo |
用户排名信息 [手环] |
Aviation 接口
[说明] 白名单设置接口
[属性] 通用接口
| API | Description |
|---|---|
| POST api/Aviation/SetAviationInfo |
设置航空单号 |
| POST api/Aviation/GetAviationInfo |
根据航空单号获取设备id |
DeviceBaseInfo 接口
设备帮扶信息相关接口
| API | Description |
|---|---|
| POST api/DeviceBaseInfo/GetWearInfo |
获取设备佩戴对象(人员)信息 |
| POST api/DeviceBaseInfo/SaveWearInfo |
保存手表设备佩戴对象(人员)信息 |
| POST api/DeviceBaseInfo/GetRelativeInfo |
获取设备佩戴对象(人员)亲属信息 |
| POST api/DeviceBaseInfo/GetVisitInfo |
获取设备佩戴对象(人员)帮扶信息 |
| POST api/DeviceBaseInfo/SaveRelativeInfo |
保存手表设备佩戴对象(人员)亲属信息 |
| POST api/DeviceBaseInfo/SaveVistRecordInfo |
保存手表设备佩戴对象(人员)帮扶信息 |
Products 接口
[说明] 产品信息
[属性] 通用接口
| API | Description |
|---|---|
| POST api/Products/GetProduct |
查询产品信息 |
| GET api/Products/GetReach |
No documentation available. |
Push 接口
[说明] 用户推送设置相关接口
[属性] 通用接口
| API | Description |
|---|---|
| POST api/Push/GetPushSetting |
获取推送设置 |
| POST api/Push/SavePushSetting |
保存用户推送设置 |
KWatch 接口
[说明] HW K1 接口
[属性] 专用接口
| API | Description |
|---|---|
| POST api/KWatch/GetAlarm |
获取闹钟 [专用接口] |
| POST api/KWatch/GetMutePeriod |
K1Watch 获取静音时段 [专用接口] |
| POST api/KWatch/ContactList |
K1Watch 联系人 [专用接口] |
| POST api/KWatch/SendSmsValidateCode |
短信方式下发验证码给手表 [专用接口] |
| POST api/KWatch/ValidateCode |
手表验证码验证 [专用接口] |
| POST api/KWatch/Bind |
设备绑定成功 app回调该接口 下发短信指令给设备 提示绑定成功 [专用接口] |
| POST api/KWatch/InstanceLocation |
K1Watch 立即定位 [专用接口] |
| POST api/KWatch/RestoreFactory |
K1Watch 恢复出厂设置 [专用接口] |
| POST api/KWatch/PowerOff |
K1Watch 关机 [专用接口] |
| POST api/KWatch/Update |
更新 [专用接口] |
| POST api/KWatch/SetAlarm |
设置闹钟 [专用接口] |
| POST api/KWatch/SetMutePeriod |
K1Watch 设置静音时段 [专用接口] |
| POST api/KWatch/SetContact |
K1Watch 设置联系人 [专用接口] |
| POST api/KWatch/PhoneSwitch |
设置拒绝陌生来电开关 [专用接口] |
| POST api/KWatch/PhoneSwitchStatus |
获取拒绝陌生来电开关状态 [专用接口] |
| POST api/KWatch/WatchLanguage |
手表最后设置的语言 [专用接口] |
| POST api/KWatch/ChangeLanguage |
设置语言 [专用接口] |
| POST api/KWatch/CheckUpdate |
检查版本 [专用接口] |
| POST api/KWatch/ConfirmUpdate |
确认更新 [专用接口] |
CarInfo 接口
[说明] 车辆信息相关接口
[属性] 车机设备接口
| API | Description |
|---|---|
| POST api/CarInfo/GetCarInfo |
获取车辆信息 |
| POST api/CarInfo/SaveCarInfo |
修改车辆信息 |
| POST api/CarInfo/ServiceProvider |
获取我的服务商 |
CarInsurance 接口
[说明] 车辆保险信息相关接口
[属性] 车机设备接口
| API | Description |
|---|---|
| POST api/CarInsurance/InsuranceSetting |
车辆保险设置 |
| POST api/CarInsurance/InsuranceCompany |
保险公司列表 |
| POST api/CarInsurance/SaveInsurance |
修改保险信息 |
| POST api/CarInsurance/InsuranceList |
保险记录列表 |
| POST api/CarInsurance/CarInsuranceInfo |
车辆保险信息 |
| OPTIONS api/CarInsurance/Options |
GuarderPosition 接口
[说明] 监护人位置
监护人通过 app 分享自己的位置
[属性] 手表接口
| API | Description |
|---|---|
| POST api/GuarderPosition/GuardersPosition |
获取监护人位置信息 [手表] |
| POST api/GuarderPosition/RemoveGuarderPosition |
删除监护人位置信息 [手表] 监护人停止分享自己的位置后,从服务器删除自己的位置 |
| POST api/GuarderPosition/UploadGuarderPosition |
监护人上传位置信息 [手表] 位置分享后。可定时上传自己的位置 |
CoupletCard 接口
[说明] 物联网卡接口
[属性] 通用接口
| API | Description |
|---|---|
| POST api/CoupletCard/CheckBalance |
话费余额查询 |
| POST api/CoupletCard/CheckRemindTime |
剩余分钟数查询 |
| POST api/CoupletCard/setMeal |
设置套餐 |
| POST api/CoupletCard/renewMeal |
套餐续费 |
| POST api/CoupletCard/payback |
话费充值 |
| POST api/CoupletCard/CheckBindNumber |
查询绑定的亲情号码 |
| POST api/CoupletCard/BothDailNet |
双向呼叫 |
Command 接口
[说明] 设备指令下发相关接口
[属性] 通用接口
| API | Description |
|---|---|
| POST api/Command/CommandList |
获取设备指令集合 |
| POST api/Command/SendCommand |
向设备发送指令 |
| OPTIONS api/Command/Options |
No documentation available. |
| POST api/Command/CommandValue |
获取设备指令值 |
| POST api/Command/SetH002Voice |
科强设置提醒语音 |
| POST api/Command/SetEventRemind |
设置事件提醒[特定设备专用接口OF] 智能语音接口 |
| POST api/Command/DeleteEventRemind |
删除事件提醒[特定设备专用接口OF] |
| POST api/Command/EventRemindList |
事件列表[特定设备专用接口OF] |
| POST api/Command/SetAlarm |
闹钟设置 [特定设备专用接口HW] |
| POST api/Command/SetMutePeriod |
设置静音时段 [特定设备专用接口HW] |
| POST api/Command/SetContact |
设置联系人 [特定设备专用接口HW] |
| POST api/Command/ContactList |
联系列表 [特定设备专用接口HW] |
Poi 接口
[说明] POI信息相关接口
[属性] 通用接口
| API | Description |
|---|---|
| POST api/Poi/GetPoiList |
获取周边指定信息类型的poi信息 |
Obd 接口
[说明] OBD数据相关接口,包括 状态,行程等
[属性] 通用接口
| API | Description |
|---|---|
| POST api/Obd/GetObdStatus |
获取OBD状态 [车机] |
| POST api/Obd/GetObdFailureByImei |
获取体检结果 |
| POST api/Obd/TravelView |
选定时间内行程视图 [车机] |
| POST api/Obd/TravelListMonthly |
月份行程列表 [车机] |
| POST api/Obd/TravelList |
自定义时间行程列表 [车机] |
| POST api/Obd/CarView |
车辆视图 [专用接口] |
| POST api/Obd/ObdTravelListTu |
Obd行程列表 [图表] |
| POST api/Obd/ObdTravelList |
Obd行程列表 [车机] |
| POST api/Obd/OBDTracking |
Get real time tracking data for a device |
| POST api/Obd/SingleTravel |
单个行程详情 [车机] |
| POST api/Obd/CheckDtcCode |
获取发动机故障码[获取最后一次的数据,若需要新数据需发指令重新查询后,再通过本接口获取] |
JsService 接口
[说明] JsService
[属性] 通用接口
| API | Description |
|---|---|
| POST api/JsService/GetCardInfo |
通过 IMSI 获取SIM卡信息。可获得 ICCID和 电话号码 |
| POST api/JsService/NewsGetCardInfo |
通过 IMSI 获取SIM卡信息。可获得 ICCID和 电话号码 |
| POST api/JsService/EditTerminalImei |
通过 IMSI 获取SIM卡信息。可获得 ICCID和 电话号码 |