"这是一份关于校招薪水应用的API接口文档,版本1.3,由路过的鱼儿于2016年10月28日编写。文档详细描述了后台接口的设计方案,包括接口的访问域名、接口前缀格式、数据交互方式以及各个关键接口的功能。"
本文档主要涉及以下几个重要的知识点:
1. **接口访问域名与端口**:所有正式上线的数据都在`www.offershow.online:8000`端口进行访问。接口的统一前缀格式为`域名地址:端口 + 应用类型名称 + API + 接口名称`,例如`http://www.offershow.online:8000/webapi/jobdetail/id`。
2. **数据交互方式**:应用前端通过form表单将数据传递给服务器,使用GET或POST请求。参数不直接在URL中传递,而是放在POST请求体中,服务器返回JSON格式的数据给前端。
3. **访问令牌机制**:所有的数据访问都需要一个访问令牌(access_token),开发者需要通过appid和appsecret来获取token。appid和appsecret的申请需联系开发者,这是为了增强数据访问的安全性。
4. **接口目录**:文档列出了多个接口,包括获取token、插入和查询薪水信息、评价薪水、获取城市和公司分类统计、统计数据、留言接口、热门标签等。所有接口现在都要求使用POST请求,并且必须携带access_token参数。
5. **接口具体功能**:
- **获取access_token接口**:用于获取访问应用的权限令牌。
- **插入单条薪水信息接口**:允许插入一条新的薪水数据。
- **查单条薪水信息接口**:根据ID获取薪水的详细信息。
- **查询所有薪水信息接口**:提供按时间、热门程度和可信度排序的查询选项。
- **薪水评价接口**:包含差评和好评接口,用于用户对薪水信息的反馈。
- **获取分类及总数接口**:获取薪水的城市和公司分类及其总数,便于数据分析。
- **薪水统计数据接口**:提供薪水的统计信息,可能包括平均值、中位数等。
- **留言接口**:用户可以对薪水信息进行留言,接口包括留言的添加和查询。
- **热门标签接口**:返回应用中热门的标签,帮助用户快速定位感兴趣的信息。
- **段子信息接口**:虽然文档中也提到了与段子相关的接口,但它们与校招薪水的主要功能似乎并不直接相关。
6. **安全性与权限管理**:使用access_token机制确保只有授权的用户和应用才能访问数据,这有助于防止未授权访问和数据泄露。
这份接口文档为开发人员提供了实现校招薪水应用功能所需的详细指南,确保了数据的正确传输和安全访问。通过遵循这些接口规范,开发者能够构建出稳定、安全的应用程序,同时为用户提供流畅的体验。