API对接

一、 什么是API?

API(Application Programming Interface,应用程序接口),是软件开发者将某个做好功能开放给外部人员使用的一个窗口。外部人员无需访问源码或理解内部代码处理细节,只需要按API规定的格式传递一些参数,即可获取期望的数据或执行期望的操作。

例如一个典型的API接口服务:查询手机号的归属地。

http://apis.juhe.cn/mobile/get?key=4c80e35a4220b955a2932a38e6511e9e&phone=15026063759

点开此链接打开页面,查询的15026063759的归属地,您只需修改地址栏中【phone=】后面的手机号,按回车,即可查询另一个手机号的归属地。

这就是API服务,您只需在请求时给服务器传递参数,无需理会如何实现,即可获取到期望的内容。

二、 API请求的组成

什么是请求?API接口的调用,是通过一个URL地址传输的,URL打开一次就是一次请求,刷新页面,又算一次请求。

请求API接口,其实就是打开访问接口的URL,此URL在请求时需要几个组成部分:

API接口地址

即API接口服务公开给外部访问的地址

  • 请求方式

常用的有Get 、Post 和其他方式,系统的支持,取决于API接口服务,无需理解,他们支持什么,我们选择对应的方式即可。

  • 请求的参数

API接口根据你传递的参数处理对应的数据。例如,phone手机号就是一个参数。

  • 授权认证方式

在请求API时,不是谁请求都会处理,需要对您的请求做认证。常见的是 token 认证和key(有时还有会结合sign)。这些信息API服务商都会给到您。

  • Header

请求过程中需要传递的表头信息,是系统级的参数,包含存储认证信息Token的参数。一般情况下我们不需要配置,需要配置时,API文档会特别说明。

  • Body

同样也是存储传递的数据,它在请求方式为Post时才需要配置。常用来存储表单信息,有时授权认证的参数也可以存储在这里。

例如,通过API接口,将一个表单数据新增到第三方系统,表单的字段名称和字段值 存放在Body中。

总体来说:调用API 接口时,需要三部分:

  1. 请求的API URL地址
  2. 传递的参数
  3. 授权身份认证

results matching ""

    No results matching ""

    results matching ""

      No results matching ""