Hi出行接口

本文主要是介绍Hi出行接口，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

 

目录

用户注册

 用户登录

添加点(需要token)

获取点

         信息的添加(需要权限)

         得到信息

         点赞

         评论

         获取点的信息个数

         关于token，对于一些需要token的可能会返回如下的信息

         取消点赞

         获取我的信息

         使用用户名获取用户信息

         上传图片

         上传视频

         上传音频

         获取评论

获取回复

回复评论

获取验证码

检验验证码

手机验证修改密码

用户上传头像

---

用户注册

1. url:/user/register

2. 参数：

   • username 用户名
   • account 账号（手机号11位）
   • password 密码
   • code 手机验证码（之前通过前端获取手机号验证码，然后再将验证码填入）

3. 返回：

   • 成功:

     {"status": 0,"message": "注册成功"
     }
     

   • 失败: 第一种情况:

     {"status": 1,"message": "该账号已被注册"
     }
     

     第二种情况(基本不会遇到):

     {"status": 2,"message": "未知错误"
     }
     

     第三种情况:

     {"status": 3,"message": "手机验证码错误"
     }

 用户登录

• url:/user/login
• 参数:
  • account 账号
  • password 密码
• 成功:

  {"status": 0,"data": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MiwidHlwZSI6InVzZXIiLCJleHAiOjE1MTkxMzI2MTQsImlhdCI6MTUxODUyNzgxNCwidXNlcm5hbWUiOiLmmJ_mrabogIUifQ.QS_DD4aBQM9KCs7v5TbxWq5tamZhibb1tjMdPDiuYCM","message": "登录成功!"
  }
  

• 失败:
  • 第一种情况

    {"status": 1,"message": "用户不存在!"
    }
    

  • 第二种情况

    {"status": 2,"message": "密码错误!"
    }
    

  • 第三种情况(基本不会遇到)

    {"status": 3,"message": "创建token错误!"
    }
    

• 说明:登录成功后需要将data的内容保存起来，对于有些链接需要用户权限才能完成，那么需要将data的内容，设置在请求头中。data中的内容为token。
  • key token
  • value data中的内容

 

 

添加点(需要token)

• url:/point/addPoint
• 参数:
  • name 点的名称
  • longitude 经度
  • latitude 纬度
• 返回:
  • 成功:

    {"status": 0,"data": 1,"message": "添加成功"
    }

  • 失败:

    {"status": 1,"message": "添加失败"
    }
    

    {"status": 2,"message": "该点已存在"
    }
    

获取点

• url:/none/getPoints
• 参数:
  • longitude 经度
  • latitude 纬度
  • range 范围 int型的
• 返回:

                 周围有点

{"status": 0,"data": [{"id": 1,"name": "test","longitude": 66.63,"latitude": 77.7,"createAt": 1559617939000,"createBy": 1,"mesCount": 0,"phoCount": 0,"audCount": 0,"vidCount": 0}],"message": null
}

周围无点 

{"status": 1,"message": "无点"
}

 

 

信息的添加(需要权限)

• url:/addMessage/{pointId}

• 参数:
  • pointId 点的id
  • content 信息的内容
• 返回:

  {"status": 0,"message": "添加成功"
  }
  

  {"status": 1,"message": "添加失败"
  }
  

 

得到信息

• url:/none/getMessage/{pointId}
• 参数:
  • pointId
  • type
• 返回
  • 有消息

    {"status": 0,"data": [{"id": 1,"pointId": 1,"type": 0,"userId": 1,"username": "test","image": "**********************************","content": {"comm": "这个是测试"},"remarkCount": 0,"clickCount": 0,"createAt": "2019-06-10 14:01:01","isClick": false}],"message": null
    }

    {"status": 0,"data": [{"id": 11,"pointId": 1,"type": 1,"userId": 1,"username": "test","image": "**********************************","content": {"title": "test","urls": ["/photo/2019052826273.png"]},"remarkCount": 0,"clickCount": 0,"createAt": "2019-05-28 07:14:49","isClick": false}],"message": null
    }

  • {"status": 0,"data": [{"id": 38,"pointId": 6,"type": 3,"userId": 2,"username": "张哲","image": "**********************************","content": {"title": "test","url": "/video/2019052399395.mp4"},"remarkCount": 0,"clickCount": 0,"createAt": "2019-05-23 03:45:13","isClick": false}],"message": null
    }

    {"status": 0,"data": [{"id": 37,"pointId": 6,"type": 2,"userId": 2,"username": "张哲","image": "**********************************","content": {"url": "/audio/2019052396416.mp3","audioSecond": 31,"audioMinutes": 3},"remarkCount": 0,"clickCount": 0,"createAt": "2019-05-23 03:43:19","isClick": false}],"message": null
    }

     

  • 无消息

    {"status": 1,"message": "无消息"
    }
    

• 说明:在得到消息是有两种状态带token和不带token，当带有token时，并且改用户点赞某条消息，那么isClick会返回false，而不带token时返回的都是false。

点赞

• url:/click
• 参数:
  • type
    • 1 是给点的信息点赞
    • 2 是给评论点赞
  • infoOrRemarkId 信息的id或者评论的id
• 返回:
  • 成功:

    {"status": 0,"message": "点赞成功"
    }
    

  • 失败

    {"status": 1,"message": "点赞失败"
    }
    

评论

• url:/remark/{infoId}
• 参数:
  • infoId 评论的消息的id
  • content 内容
• 返回

成功

{"status": 0,"message": "评论成功"
}

失败

{"status": 1,"message": "评论失败"
}

 

获取点的信息个数

 

• url:/none/getItems/{pointId}
• 参数
  • pointId
• 返回

{"status": 0,"data": {"pointId": 7,"mesCount": 0,"phoCount": 0,"audCount": 0,"vidCount": 0}
}

关于token，对于一些需要token的可能会返回如下的信息

需要却没有带token

{"status": -1,"message": "未登录"
}

token过期，需要重新登录

{"status": -2,"message": "登录过期"
}

登录异常，可能已经在别处登录

{"status": -3,"message": "登录异常"
}

 

 取消点赞

url:/unclick

• 方法：POST

• token： 需要

• 参数：

• type: 0信息 1 评论 2

• infoOrRemarkId 信息或者评论的id

• 返回:

  + 成功:```{"status": 0,"message": "取消点赞成功"}```+ 失败```{"status": 1,"message": "取消点赞失败"}```

获取我的信息

• url:/me
• token:需要
• 返回：

{"status": 0,"data": {"id": 3,"username": "xiaoming","account": "12345678910"}
}

使用用户名获取用户信息

• url:/user
• 参数:username: 用户名
• 方法：POST
• 返回：

   {"status": 0,"data": {"id": 2,"username": "星武者","account": "13572011907"}
}```

上传图片

• url:/uploadPhotos/{pointId}
• token: 需要
• 方法：POST
• 参数：
  • title: 图片的标题
  • file :所传图片

1. 参数：

   • 成功：

   {"status": 0,"data":"返回图片的urls""message": "文件上传成功"
   }
   

   • 失败

   {"status": 1,"message": "文件内容为空"
   }
   

   {"status": 2,"message": "文件上传出错"
   }
   

   {"status": 3,"message": "文件上传失败"
   }
   

上传视频

• url:/uploadVideo/{pointId}
• 方法：POST
• 参数：
  • file 文件
  • title  视频必须有title
  • 返回
    • 成功

    {"status": 0,"message": "文件上传成功"
    }
    

    • 失败

    {"status": 1,"message": "文件内容为空"
    }
    

    {"status": 2,"message": "文件上传出错"
    }
    

    {"status": 3,"message": "文件上传失败"
    }
    

    {"status": 4,"message": "类型不合法"
    }
    

    {"status": 5,"message": "无效的标题"
    }

上传音频

• url:/uploadAudio/{pointId}
• 方法：POST
• 参数：
  • file 文件
  • second 音频秒数
  • minutes 音频分钟数
  • title  音频不能有title
  • 返回
    • 成功

    {"status": 0,"message": "文件上传成功"
    }
    

    • 失败

    {"status": 1,"message": "文件内容为空"
    }
    

    {"status": 2,"message": "文件上传出错"
    }
    

    {"status": 3,"message": "文件上传失败"
    }
    

    {"status": 4,"message": "类型不合法"
    }
    

获取评论

• url:/none/getRemarks
• 参数：
  • infoId 消息的id
  • pageNo 页号
  • pageSize 页面大小
• 返回
  • 成功

{"status": 0,"data": [{"id": 1,"content": "今天天气不错","createAt": "2018-05-17 20:57:49","createBy": {"id": 2,"username": "星武者","account": "13572011907"},"totalReplay": 2,    // 总的回复数量"replays": [{"id": 1,"commId": 1,    // 评论的id"fromUser": {"id": 2,"username": "星武者","account": "13572011907"},"toUser": {"id": 3,"username": "woxin","account": "1293141942"},"content": "今天我很高兴","createAt": "2018-05-28 04:37:21","click": 0},{"id": 2,"commId": 1,"fromUser": {"id": 3,"username": "woxin","account": "1293141942"},"toUser": {"id": 2,"username": "星武者","account": "13572011907"},"content": "为什么呢","createAt": "2018-05-28 04:42:39","click": 0}],"clickCount": 0,"click": false}]
}

{"status": 1,"message": "无消息"
}

• 说明：这里只会显示三条回复，并且回复没有是否点赞

获取回复

• url:/none/replay
• 方法：GET
• 参数：
  • pageNo: 第几页
  • pageSize:每页的大小
  • remarkId：评论的id
  • 返回：

{"status": 0,"data": [{"id": 1,"commId": 8,"fromUser": {"id": 1,"username": "test","account": "13772122697","image": "image.haojianqiang.top/5ac033f7-32c5-459e-859e-20e0d703bd02"},"toUser": {"id": 1,"username": "test","account": "13772122697","image": "image.haojianqiang.top/5ac033f7-32c5-459e-859e-20e0d703bd02"},"content": null,"createAt": "2019-05-30 08:50:33","isClick": false,"click": 0},{"id": 5,"commId": 8,"fromUser": {"id": 1,"username": "test","account": "13772122697","image": "image.haojianqiang.top/5ac033f7-32c5-459e-859e-20e0d703bd02"},"toUser": {"id": 1,"username": "test","account": "13772122697","image": "image.haojianqiang.top/5ac033f7-32c5-459e-859e-20e0d703bd02"},"content": null,"createAt": "2019-05-30 08:56:53","isClick": false,"click": 0},{"id": 6,"commId": 8,"fromUser": {"id": 1,"username": "test","account": "13772122697","image": "image.haojianqiang.top/5ac033f7-32c5-459e-859e-20e0d703bd02"},"toUser": {"id": 1,"username": "test","account": "13772122697","image": "image.haojianqiang.top/5ac033f7-32c5-459e-859e-20e0d703bd02"},"content": "测试测试1","createAt": "2019-05-30 08:58:53","isClick": false,"click": 0}],"message": null
}

{"status": 1,"message": "无回复"
}

回复评论

• url:replay/{commId} commId: 评论的id
• 方法：POST
• 参数：
  • toId: 评论的目标用户
  • content: 评论的内容
• 返回：

{"status": 0,"message": "回复成功"
}

获取验证码

• url:/utils/getphonecode
• 参数：
  • phonenumber 手机号
• 返回：
  • 成功:

    {"status": 0,"data":code  (后台验证的凭证)"message": "获取成功"
    }
    

  • 失败:

    {"status": -1,"message": "验证码发送失败!"
    }
    

检验验证码

• url:/utils/judgephone
• 参数：
  • code 上面接口获取的data
  • phonenumber 手机号
• 返回：
  • 成功:

    {"status": 0,"message": "验证成功"
    }
    

  • 失败:

    {"status": -1,"message": "验证失败!"
    }

手机验证修改密码

不需要token

1. 验证手机号 之后才能进行修改密码
   • url:/user/changepassword
   • 参数：
     • account 手机号
     • password 新密码
     • sedpassword 再次输入的新密码
   • 返回：
     • 成功:

       {"status": 0,"message": "修改成功"
       }
       

     • 失败:

       {"status": -1,"message": "输入的两次密码不同"
       }
       {"status": -2,"message": "jdbc修改失败"
       }

 

用户上传头像

需要token

1. • url:/qiniuIcon
   • 参数：
     • image 头像文件
     • token
   • 返回：
     • 成功:

       {"status": 0,"message": "头像上传成功"
       }
       

     • 失败:

       {"status": 1,"message": "头像为空"
       }
       {"status": -1,"message": "头像上传七牛云发生异常！"
       }
       {"status": -2,"message": "没有此用户！"
       }
       {"status": -3,"message": "头像上传数据库失败！"
       }

 

 

这篇关于Hi出行接口的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！

---