[TOC] API(Application Programming Interface,应用程序编程接口),在php中简单的理解为两个系统之间数据的交互。 ## oAuth OAUTH协议为用户资源的授权提供了一个安全的、开放而又简易的标准。与以往的授权方式不同之处是OAUTH的授权不会使第三方触及到用户的帐号信息(如用户名与密码),即第三方无需使用用户的用户名与密码就可以申请获得该用户资源的授权,因此OAUTH是安全的。oAuth是Open Authorization的简写。(例子:qq登录) 相关资料:[理解OAuth 2.0](http://www.ruanyifeng.com/blog/2014/05/oauth_2_0.html) ## RESTful 一种软件架构风格,设计风格而不是标准,只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机制。[理解RESTful架构](http://www.ruanyifeng.com/blog/2011/09/restful.html) [RESTful API 设计指南](http://www.ruanyifeng.com/blog/2014/05/restful_api) 协议### API与用户的通信协议,总是使用HTTP或者HTTPs协议。 ### 域名 应该尽量将API部署在专用域名之下。 ~~~ https://api.example.com ~~~ 如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下。 ~~~ https://example.org/api/ ~~~ ### 版本 应该将API的版本号放入URL。 ~~~ https://api.example.com/v1/ ~~~ 另一种做法是,将版本号放在HTTP头信息中,但不如放入URL方便和直观。Github采用这种做法。 ### 路径 路径又称"终点"(endpoint),表示API的具体网址。 在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的"集合"(collection),所以API中的名词也应该使用复数。 举例来说,有一个API提供动物园(zoo)的信息,还包括各种动物和雇员的信息,则它的路径应该设计成下面这样。 ~~~ https://api.example.com/v1/zoos https://api.example.com/v1/animals https://api.example.com/v1/employees ~~~ ### HTTP动词 对于资源的具体操作类型,由HTTP动词表示。 常用的HTTP动词有下面五个(括号里是对应的SQL命令)。 ~~~ GET(SELECT):从服务器取出资源(一项或多项)。 POST(CREATE):在服务器新建一个资源。 PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。 PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)。 DELETE(DELETE):从服务器删除资源。 ~~~ 还有两个不常用的HTTP动词。 ~~~ HEAD:获取资源的元数据。 OPTIONS:获取信息,关于资源的哪些属性是客户端可以改变的。 ~~~ ### 过滤信息 如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。 下面是一些常见的参数。 ~~~ ?limit=10:指定返回记录的数量 ?offset=10:指定返回记录的开始位置。 ?page=2&per_page=100:指定第几页,以及每页的记录数。 ?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序。 ?animal_type_id=1:指定筛选条件 ~~~ 参数的设计允许存在冗余,即允许API路径和URL参数偶尔有重复。比如,GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。 ### 状态码 服务器向用户返回的状态码和提示信息,常见的有以下一些(方括号中是该状态码对应的HTTP动词)。 ~~~ 200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。 201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。 202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务) 204 NO CONTENT - [DELETE]:用户删除数据成功。 400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。 401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。 403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。 404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。 406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。 410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。 500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。 ~~~ ### 错误处理 如果状态码是4xx,就应该向用户返回出错信息。一般来说,返回的信息中将error作为键名,出错信息作为键值即可。 ~~~ { error: "Invalid API key" } ~~~ ### 返回结果 针对不同操作,服务器向用户返回的结果应该符合以下规范。 ~~~ GET /collection:返回资源对象的列表(数组) GET /collection/resource:返回单个资源对象 POST /collection:返回新生成的资源对象 PUT /collection/resource:返回完整的资源对象 PATCH /collection/resource:返回完整的资源对象 DELETE /collection/resource:返回一个空文档 ~~~ ## 设计要点 ### 权限 api应用分为公开和授权的,公开接口不需要验证权限直接可以进行调用,授权接口需要验证调用者的身份,可通过get参数传递或者HTTP头信息里面增加传递,接口提供方接到信息之后验证是否有权限,再返回相对应该的数据。 ~~~ <?php $ch = curl_init(); $url = 'http://apis.baidu.com/kingtto_media/106sms/106sms?mobile=13205516161&content=%E3%80%90%E5%87%AF%E4%BF%A1%E9%80%9A%E3%80%91%E6%82%A8%E7%9A%84%E9%AA%8C%E8%AF%81%E7%A0%81%EF%BC%9A888888'; $header = array( 'apikey: 您自己的apikey', ); // 添加apikey到header curl_setopt($ch, CURLOPT_HTTPHEADER , $header); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); // 执行HTTP请求 curl_setopt($ch , CURLOPT_URL , $url); $res = curl_exec($ch); var_dump($res); ?> ~~~ ### 数据格式 目前常用的接口传输数据格式为json和xml, json的使用量相对比较多,很多种语言都支持这种数据格式。 ~~~ { "returnstatus": "Success",---------- 返回状态值:成功返回Success 失败返回:Faild "message": "ok",---------- 返回信息 "remainpoint": "0",---------- 运营商结算无意义,可不用解析 "taskID": "123456",---------- 返回本次任务的序列ID "successCounts": "1"---------- 返回成功短信数 } ~~~ ~~~ XML 返回示例: ------------------------------------------------------------------------------------------------------- <?xml version="1.0" encoding="utf-8" ?> <returnsms> <returnstatus>status</returnstatus>---------- 返回状态值:成功返回Success 失败返回:Faild <message>message</message>---------- 返回信息 <remainpoint> remainpoint</remainpoint>---------- 运营商结算无意义,可不用解析 <taskID>taskID</taskID>---------- 返回本次任务的序列ID <successCounts>successCounts</successCounts>---------- 返回成功短信数 </returnsms> ~~~