作为专业的开发人员,我们经常要面向开发者开发API接口,或者根据其他开发者提供的API接口进行开发。
什么是API?
百度百科的解释:API是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。
说简单点就是,我要将我的数据、程序调用方式等提供给其他开发者接入,告知他调用的方法所编写的专业性文档。
例如我前不久编写的一个API接口文档:
邮件查询接口
Url地址:/mail_code/mail_search_json.php
请求调用方式:
通过HTTP的POST方式提交请求
请求参数定义:序号参数类型说明
1mailid字符串必填参数。账号:运单号
响应信息:
返回Json格式响应字符串,例如:
{"code":0, "expresstracking":"-08-16 16:35:12,韩国 首尔,收件|-08-17 17:24:20,韩国,准备运往机场|-08-17 21:10:42,韩国,到达机场 安检|-08-18 08:24:45,韩国,离开处理中心发往中国广州|-08-20 09:15:30,广州市,离开广州市发往武汉市(经转)|-08-21 12:00:24,武汉市,到达武汉处理中心(经转)|-08-22 08:14:04,武汉市,货物运至海关监管仓|-08-24 11:25:05,武汉市,货物放行转至国内快递"}
响应参数定义:序号参数说明
1code整型,响应编码 默认0:执行成功
2expresstracking字符串。响应信息,物流详细信息。
响应编码定义(暂定):
0:执行成功
101:没有相关物流信息
如何完整的编写API接口,将在下一篇讲解。如何用PHP完整的编写一个API接口?点击链接查看。