网站api接口方案（统一api接口平台设计）

本篇文章给大家谈谈网站api接口方案，以及统一api接口平台设计对应的知识点，希望对各位有所帮助，不要忘了收藏本站喔。 今天给各位分享网站api接口方案的知识，其中也会对统一api接口平台设计进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

本文目录一览：

• 1、API接口安全设计方案（已实现）
• 2、怎么为自己的网站编写api接口
• 3、如何设计出一些优雅的API接口
• 4、Web API接口鉴权方式

API接口安全设计方案（已实现）

网络安全方案，主要从数据加密与api接口安全两个方面考虑，数据加密https已经加密网站api接口方案了，就不再次加密了网站api接口方案；主要从api安全方面考虑。

在代码层面，对接口进行安全设计
一、使用token进行用户身份认证
二、使用sign防止传入参数被篡改
三、用时间戳防止暴力请求

用户身份认证的流程图如下：

具体说明如下：

1、 用户登录时，客户端请求接口，传入用户名和密文的密码
2、 后台服务对用户身份进行验证。若验证失败，则返回错误结果网站api接口方案；若验证通过，则生成一个随机不重复的token，并将其存储在redis中，设置一个过期时间。
其中，redis的key为token，value为验证通过后获得的用户信息
3、 用户身份校验通过后，后台服务将生成的token返回客户端。
客户端请求后续其网站api接口方案他接口时，需要带上这个token。后台服务会统一拦截接口请求，进行token有效性校验，并从中获取用户信息，供后续业务逻辑使用

为了防止中间人攻击（客户端发来的请求被第三方拦截篡改），引入参数的签名机制。
具体步骤如下：

1、客户端和服务端约定一个加密算法（或MD5摘要也可）， 客户端发起请求时，将所有的非空参数按升序拼在一起，通过加密算法形成一个sign，将其放在请求头中传递给后端服务。
2、后端服务统一拦截接口请求，用接收到的非可空参数根据约定好的规则进行加密，和传入的sign值进行比较。若一致则予以放行，不一致则拒绝请求。

由于中间人不知道加密方法，也就不能伪造一个有效的sign。从而防止了中间人对请求参数的篡改。

sign机制可以防止参数被篡改，但无法防dos攻击（第三方使用正确的参数，不停请求服务器，使之无法正常提供服务）。因此，还需要引入时间戳机制。
具体的操作为：客户端在形成sign值时，除了使用所有参数和token外，再加一个发起请求时的时间戳。即

sign值来源 = 所有非空参数升序排序+token+timestamp

而后端则需要根据当前时间和sign值的时间戳进行比较，差值超过一段时间则不予放行。
若要求不高，则客户端和服务端可以仅仅使用精确到秒或分钟的时间戳，据此形成sign值来校验有效性。这样可以使一秒或一分钟内的请求是有效的。
若要求较高，则还需要约定一个解密算法，使后端服务可以从sign值中解析出发起请求的时间戳。
总结后的流程图如下：

这里还是隐藏下了。

规则：sha1(keyvalkeyval+token+timestamp+id)

例如：sha1（address33bussinessType22city111companyNamest232ringtokentimestampid）

这里新增一个id值，与token对应，传输过程中不使用，只用于加密，保证数据即使被截获，因为请求中没有id的传输，更加安全。

token身份认证；

timestamp方式防止dos攻击，防止重放，简单说就是一次接口调用，只能用一定时间，比如比对时间，60s内该次调用有效，60秒后失效；

sign签名，通过参数+token+timestamp+id固定位加密，保证参数不会被修改，调用有效；

怎么为自己的网站编写api接口

80%的都用webservice 新浪微博API（java版） ============================ 修改事项： 1、接口返回结果采用json对象方式封装 2、修改WeiboResponse中空字符串("")调用判断的bug 3、修改了JSONObject中返回空对象的问题 4、增加了直接文件上传接口直接 常用接口实例： （使用前先修改 Weibo.java 中 public static final String CONSUMER_KEY = ""; public static final String CONSUMER_SECRET = ""; 填写成实际申请的 CONSUMER_KEY 及 CONSUMER_SECRET） 1、获取最新公共微博列表 参考：weibo4j.examples.GetTimelines 中的getPublicTimeline()部分 2、发表微博 参考：weibo4j.examples.Update 中的updateStatus(...)部分 3、发表评论 参考：weibo4j.examples.Update 中的updateComment(...)部分 4、删除评论 参考：weibo4j.examples.Update 中的destroyComment(...)部分 5、发送私人消息 参考：weibo4j.examples.DirectMessage 类 6、发表带图片的微博 参考：weibo4j.examples.OAuthUploadByFile 中的uploadStatus(status,file)部分 7、更新用户头像 参考：weibo4j.examples.OAuthUpdateProfile类 8、OAuth桌面应用访问 步骤： 1 在weibo4j.examples.OAuthUpdate 访问认证的URL，得到pin 2 在weibo4j.examples.OAuthUpdate 输入pin，然后得到AccessToken 3 即可访问用户的微博，参考：weibo4j.examples.OAuthUpdateTwo 9、OAuth WEB应用访问 步骤： 1 在weibo4j.examples.WebOAuth 带backurl参数请求OAuth认证，获得RequestToken 2 在callback 的地址里面，接受到oauth_verifier参数，然后再发一次请求，即可获得AccessToken 3 用AccessToken访问用户的微博 实例说明： 在web目录下面有两个jsp页面： call.jsp 是发送request的请求，在第九行的参数“http://localhost:8080/callback.jsp”是回调地址 当获取成功后将RequestToken置入session，并重定向到用户认证地址 callback.jsp 接收到oauth_verifier参数，从session里面拿到RequestToken，再请求获取AccessToken 获取到后即可对用户微博进行操作，本例中是发表微博 测试环境： 本例中可以将call.jsp和 callback.jsp直接放到tomcat的根目录下面：webapps\ROOT 并将实例项目编译好的classes文件和lib目录拷贝到ROOT\WEB-INF下面 重启tomcat，访问http://localhost:8080/call.jsp?opt=1 注：也可以打成war包，但注意call.jsp里面的callback参数需要做相应修改 ============================================================================= 其他接口在weibo4j.Weibo类中定义，调用方式请参考weibo4j.examples，下面是完整的接口列表： 获取下行数据集(timeline)接口 方法名： statuses/public_timeline 最新公共微博 方法名：getPublicTimeline statuses/friends_timeline 最新关注人微博 (别名: statuses/home_timeline) 方法名：getFriendsTimeline statuses/user_timeline 用户发表微博列表 方法名：getUserTimeline(String id, Paging paging) statuses/mentions 最新 @用户的 方法名： getMentions() statuses/comments 单条评论列表(按微博) 方法名：getComments() 微博访问接口 statuses/show 获取单条 方法名：showStatus(long id) statuses/update 发表微博 方法名：updateStatus(String status) statuses/upload 发表微博及图片 方法名：uploadStatus(String status,File file) statuses/destroy 删除 方法名： destroyStatus(long statusId) statuses/comment 评论 方法名： destroyComment(long commentId) statuses/comment_destroy 删除评论 方法名：destroyComment 私信接口 direct_messages 我的私信列表 方法名：getDirectMessages() 分页 getDirectMessages(Paging paging) direct_messages/sent 我发送的私信列表 方法名：getSentDirectMessages() direct_messages/new 发送私信 方法名：sendDirectMessage(String id,String text) direct_messages/destroy 删除一条私信 方法名：destroyDirectMessage(int id) 关注接口 friendships/create 关注某用户 方法名：createFriendship(String id)或 createFriendship(String id, boolean follow) friendships/destroy 取消关注 方法名： destroyFriendship(String id) friendships/exists 是否关注某用户 方法名：existsFriendship(String userA, String userB) friends/ids 关注列表 方法名： getFriendsIDs(long cursor) followers/ids 粉丝列表 方法名：getFollowersIDs(long cursor) 账号接口 account/verify_credentials 验证身份是否合法 方法名：verifyCredentials() account/rate_limit_status 查看当前频率限制 方法名：rateLimitStatus() account/update_profile_image 更改头像 方法名：updateProfileImage(File image) account/update_profile 更改资料 方法名：User updateProfile(String name, String email, String url, String location, String description) 收藏接口 favorites 收藏列表 方法名：getFavorites() favorites/create 添加收藏 方法名：createFavorite(long id) favorites/destroy 删除收藏 方法名：destroyFavorite(long id)
采纳哦

如何设计出一些优雅的API接口

API（Application Programming Interface,应用程序编程接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。
API函数包含在Windows系统目录下的动态连接库文件中。Windows API是一套用来控制Windows的各个部件的外观和行为的预先定义的Windows函数。用户的每个动作都会引发一个或几个函数的运行以告诉Windows发生了什么。这在某种程度上很像Windows的天然代码。而其他的语言只是提供一种能自动而且更容易的访问API的方法。当你点击窗体上的一个按钮时，Windows会发送一个消息给窗体，VB获取这个调用并经过分析后生成一个特定事件。
更易理解来说：Windows系统除了协调应用程序的执行、内存的分配、系统资源的管理外，同时他也是一个很大的服务中心。调用这个服务中心的各种服务(每一种服务就是一个函数)可以帮助应用程序达到开启视窗、描绘图形和使用周边设备等目的，由于这些函数服务的对象是应用程序，所以称之为Application Programming Interface，简称API 函数。WIN32 API也就是MicrosoftWindows 32位平台的应用程序编程接口。
凡是在 Windows工作环境底下执行的应用程序，都可以调用Windows API。
linux API
在linux中，用户编程接口API遵循了UNIX中最流行的应用编程界面标准---POSIX标准。POSIX标准是由IEEE和ISO/IEC共同开发的标准系统。该标准基于当时现有的UNIX实践和经验，描述了操作系统的系统调用编程接口API，用于保证应用程序可以在源程序一级上在多种操作系统上移植运行。这些系统调用编程接口主要是通过C库（LIBC）来实现的。
2开放平台
基于互联网的应用正变得越来越普及，在这个过程中，有更多的站点将自身的资源开放给开发者来调用。对外提供的API 调用使得站点之间的内容关联性更强，同时这些开放的平台也为用户、开发者和中小网站带来了更大的价值。
开放是目前的发展趋势，越来越多的产品走向开放。目前的网站不能靠限制用户离开来留住用户，开放的架构反而更增加了用户的粘性。在Web 2.0的浪潮到来之前，开放的API 甚至源代码主要体现在桌面应用上，而现在越来越多的Web应用面向开发者开放了API。
具备分享、标准、去中心化、开放、模块化的Web 2.0站点，在为使用者带来价值的同时，更希望通过开放的API 来让站点提供的服务拥有更大的用户群和服务访问数量。
站点在推出基于开放API 标准的产品和服务后，无需花费力气做大量的市场推广，只要提供的服务或应用出色易用，其他站点就会主动将开放API 提供的服务整合到自己的应用之中。同时，这种整合API 带来的服务应用，也会激发更多富有创意的应用产生。
为了对外提供统一的API 接口，需要对开发者开放资源调用API 的站点提供开放统一的API接口环境，来帮助使用者访问站点的功能和资源。
当然，开放API 的站点为第三方的开发者提供良好的社区支持也是很有意义的，这有助于吸引更多的技术人员参与到开放的开发平台中，并开发出更为有趣的第三方应用。
视频云技术提供商CC视频开放API接口，用户可以在自己的网站后台轻松完成视频的上传、视频播放控制操作，并可批量获取视频及平台信息。
正如在"什么是API"中所说,API函数包含在位于系统目录下的DLL文件中。你可以自己输入API函数的声明，但VB提供了一种更简单的方法,即使用API Text Viewer。 要想在你的工程中声明API函数，只需运行API Text Viewer,打开Win32api.txt或MDB。如果你已经把它转换成了数据库的话，这样可以加快速度。 使用预定义的常量和类型也是同样的方法。 API除了有应用“应用程序接口”的意思外，还特指API的说明文档，也称为帮助文档。
假设你想在你的窗体模块中声明一个函数，粘贴然后运行，VB会告诉你：编译错误...Declare 语句不允许作为类或对象模块中的Public(公共的) 成员。..看起来很糟糕，其实你需要做的只是在声明前面添加一个Private(私有的)。不要忘了，可是这将使该函数只在该窗体模块可用。. 在有些情况下，你会得到"不明确的名称"这样的提示，这是因为函数、常量或其他的什么东西共用了一个名称。由于绝大多数的函数都进行了别名化，亦即意味着你可以通过Alias子句使用其它的而不是他们原有的名称，你只需简单地改变一下函数名称而它仍然可以正常运行。
远程过程调用（RPC）：通过作用在共享数据缓存器上的过程（或任务）实现程序间的通信。
标准查询语言（SQL）：是标准的访问数据的查询语言，通过通用数据库实现应用程序间的数据共享。
文件传输：文件传输通过发送格式化文件实现应用程序间数据共享。
信息交付：指松耦合或紧耦合应用程序间的小型格式化信息，通过程序间的直接通信实现数据共享。
当前应用于 API 的标准包括ANSI 标准SQL API。另外还有一些应用于其它类型的标准尚在制定之中。API 可以应用于所有计算机平台和操作系统。这些API 以不同的格式连接数据。每种数据格式要求以不同的数据命令和参数实现正确的数据通信，但同时也会产生不同类型的错误。因此，除了具备执行数据共享任务所需的知识以外，这些类型的API 还必须解决很多网络参数问题和可能的差错条件，即每个应用程序都必须清楚自身是否有强大的性能支持程序间通信。相反由于这种API 只处理一种信息格式，所以该情形下的信息交付API 只提供较小的命令、网络参数以及差错条件子集。正因为如此，交付API 方式大大降低了系统复杂性，所以当应用程序需要通过多个平台实现数据共享时，采用信息交付API 类型是比较理想的选择。
API 接口属于一种操作系统或程序接口，GUI接口属于一种图形操作系统。两者都属于直接用户接口。有时公司会将 API 作为其公共开放系统。也就是说，公司制定自己的系统接口标准，当需要执行系统整合、自定义和程序应用等操作时，公司所有成员都可以通过该接口标准调用源代码，该接口标准被称之为开放式API。

Web API接口鉴权方式

如果把API接口直接暴露在互联网上是存在安全风险网站api接口方案的网站api接口方案，所以我们需要对API进行权限划分网站api接口方案，对接口调用方做一个用户鉴权，如果鉴权通过则允许此用户进行API调用，反之则拒绝。根据不同的业务场景，接口鉴权方案也有很多种。
2、优点技术实现方便。3、缺点弊端

存在安全风险：因为Cookie是存储在客户端的，客户端可以随意更改Cookie，存在伪造请求的风险

Token（令牌）是用来替代Session的新兴鉴权方案，现在的Web API基本上离不开Token令牌。1、实现原理

2、优点

3、Token的实现形式 Token令牌技术是一种技术方案统称，具体的实现方案是有所差别的，最常见的Token种类有以下几种：

HTTP协议的认证机制主要有两种： 关于网站api接口方案和统一api接口平台设计的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。 网站api接口方案的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于统一api接口平台设计、网站api接口方案的信息别忘了在本站进行查找喔。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。