• 快速入门
  • HTTP文档
  • .NET开发指南
  • DEMO下载
  • 调用HTTP常见问题
    Show / Hide Table of Contents
    • 登录接口
      • 名词解释
      • 用户登录
      • 重新登录
    • 写值流程
      • 新增FBox分组
      • FBox新增
      • 新增监控点分组
      • 新增数据监控点
      • FBox列表获取
      • FBox监控点列表
      • 监控点值写入
      • 获取监控点值
    • 获取信息接口
      • 获取单个盒子
      • 获取监控点分组
      • 获取某些监控点
      • 根据监控点分组获取监控点
      • 获取物联网卡Iccid、Imei
      • 获取盒子地理位置
      • 获取HMI外部变量
    • 远程下载
      • 获取FBox驱动列表
      • 下载盒子驱动
      • 获取连接设备的寄存器类型
      • 获取服务器驱动列表
    • 盒子修改接口
      • 修改FBox分组
      • FBox名称修改
      • 修改数据监控点
      • 修改省流量模式刷新间隔
    • 盒子删除接口
      • 删除FBox分组
      • FBox删除
      • 删除监控点分组
      • 删除数据监控点
    • 报警接口
      • 报警分组接口
        • 获取报警分组列表
        • 新增报警分组
        • 修改报警分组
        • 删除报警分组
      • 报警联系人接口
        • 获取报警联系人列表
        • 获取单个报警联系人
        • 新增报警联系人
        • 修改报警联系人
        • 删除报警联系人
      • 报警记录接口
        • 获取报警条目列表
        • 获取某些报警条目
        • 新增报警条目
        • 修改报警条目
        • 删除报警条目
        • 获取报警历史
        • 获取报警条目状态
        • 确认报警
    • 历史记录接口
      • 获取历史记录条目
      • 获取某些历史记录条目
      • 新增历史记录
      • 更新历史记录
      • 删除历史记录
      • 获取历史记录数据
    • 监控点推送控制接口
      • 开启某监控点组别
      • 停止某监控点组别
      • 开启监控点组别列表
      • 停止监控点组别列表
      • 开启FBox所有监控点
      • 停止FBox所有监控点
      • 开启某条监控点
      • 停止某条监控点
      • 开启某些监控点
      • 停止某些监控点
      • 只开启某些监控点
      • 只开启某监控点组
      • 只开启某些监控点组
    • 数据推送(SignalR)
      • 实时数据推送(signalR)
      • FBox状态变更推送
      • 实时数据推送
      • 报警触发推送
      • 报警还原推送
    • 统一写值
      • 获取所有统一写分组
      • 统一写分组值写入
    • 附录
      • 附录一
      • 附录二
      • 附录三
      • 429状态码

    用户登录

    方式一:(在Manager平台上创建的开发者账号只能用方式一传参)

    • 接口功能

      该接口用于用户获取accessToken。

      注意:
      获取到的accessToken有效期是大约2小时,调用接口若出现401错误则重新调用用户登录接口获取accessToken,不要访问频繁,若超过一定频率,会屏蔽IP处理。
      注意:
      该文档中所有接口均不支持跨域请求

    • 请求地址:(二选一)

      新版:

      URL:[Host Server]/idserver/core/connect/token

      旧版:

      URL:[Id Server]/core/connect/token

    • 地址参数说明

      参数名 类型 参数描述
      Id Server string 详情见名词解释
    • Method

      POST

    • Headers

      NULL

    • Body

      参数名 类型 描述
      scope string fbox
      client_id string 开发者ID
      client_secret string 密钥原文
      grant_type string client_credentials

    注意 :

    登录接口的Content-Type(body的格式)为application/x-www-form-urlencoded 。 其他接口body的格式若无特殊说明,均为application/json格式,具体以相关接口页面的格式为准。

    client_id、client_secret为在Manager平台创建的开发者ID、密钥,详情见开发者创建页面。

    scope和grant_type为描述中所述固定值。

    • 返回字段

      字段名 类型 参数描述
      access_token string accessToken
      expires_in int accessToken的有效期
      token_type string accessToken的类型(Bearer)固定值
    • 返回码

      返回码 描述
      400 "error_description"="invalid_username_or_password"(账号或密码错误)
      或"error": "invalid_client"(开发者账号或密码错误)
      404 接口不存在,请检查URL
      429 被服务器拒绝(登录过于频繁,客户端被禁止等),详情见429状态码
    • 调用案例如下图



    方式二:(向我司销售申请的开发者账号只能用方式二方式传参)

    • 接口功能

      该接口用于用户获取accessToken。

      注意:
      获取到的accessToken有效期是2小时,refreshToken有效期为30天,调用接口若出现401错误则通过refreshToken调用重新登录接口刷新accessToken,若通过refreshToken获取不到再通过用户名和密码获取,不要访问频繁,若超过一定频率,会屏蔽IP处理。
      注意:
      该文档中所有接口均不支持跨域请求

    • 请求地址:(二选一)

      新版:

      URL:[Host Server]/idserver/core/connect/token

      旧版:

      URL:[Id Server]/core/connect/token

    • 参数说明

      参数名 类型 参数描述
      Id Server string 详情见名词解释
    • Method

      POST

    • Headers

      NULL

    • Body

      参数名 类型 描述
      username string FBox 客户端账号
      password string FBox 客户端密码
      scope string openid offline_access fbox email profile
      client_id string 开发者账号
      client_secret string 开发者密码
      grant_type string password

      注意 :
      登录接口与重新登录接口的Content-Type(body的格式)为application/x-www-form-urlencoded
      其他接口body的格式某些为application/json格式,具体以相关接口页面的格式为准。

      username、password为登录FlexManager账号密码。请自行下载FlexManager并注册

      client_id、client_secret为服务器为各种客户端所创建的开发者账号、密码,用于区分各类客户端,请联系与贵公司对接的销售获取。

      scope和grant_type为描述中所述固定值。

    • 返回字段

      字段名 类型 参数描述
      access_token string accessToken
      expires_in int accessToken的有效期
      refresh_token string accessToken过期后,刷新accessToken
      token_type string accessToken的类型(Bearer)固定值
    • 返回码

      返回码 描述
      400 "error_description"="invalid_username_or_password"(账号或密码错误)
      或"error": "invalid_client"(开发者账号或密码错误)
      404 接口不存在,请检查URL
      429 被服务器拒绝(登录过于频繁,客户端被禁止等)
    • 调用案例如下图

    Back to top Generated by DocFX