首页 > 综合百科 > 什么是API接口?API接口的定义及类型介绍

什么是API接口?API接口的定义及类型介绍

时间:2023-08-26 17:20:56 浏览量:

API接口的定义

API接口(Application Programming Interface)是预先定义的函数,能够为程序之间数据交互和功能触发提供服务。调用者只需调用API,并输入预先约定的参数,即可实现开发者封装好的各种功能,无需访问功能源码或理解功能的具体实现机制。

从功能角度来看,API是前端调用后端数据的通道;从业务角度来看,API是将封装后的应用对外开放的访问接口。在信息系统内部,随着业务功能的逐渐细化,各个功能模块之间需要利用API技术来进行协调;在信息系统外部,API承担着与其他应用程序进行交互的重要任务。

API接口的类型

按照开放程度分类,API接口可以分为开放API、面向合作方API和内部API。

开放API是面向公网开放的接口,此类API允许公众调用。调用者可以是任何人或者机构,不需要和API提供者建立合作关系,例如公司门户网站等。

面向合作方API指的是企业或组织用来与外部合作伙伴进行沟通、交流和系统集成的API,例如面向外包机构、设备供应商等。

内部API仅在企业或组织内部使用,用来协调内部不同系统、应用之间的调用关系,例如CRM系统API、薪资系统API等。

按照API核心技术分类,API可以分为简单对象访问协议(Simple Object Access Protocol,SOAP)API,RESTful(Representational State Transfer,REST)API及远程过程调录(Remote Procedure Call,RPC)API。

SOAPAPI是指使用Web服务安全性内置协议的API。基于XML协议,此类API技术可与多种互联网协议和格式结合使用,包括超文本传输协议(HTTP)、简单邮件传输协议(SMTP)、多用途网际邮件扩充协议(MIME)等。

RPCAPI是指使用远程过程调录协议进行编程的API,RPC技术允许计算机调用其他计算机的子系统,并定义了结构化的请求方式。

不同于上述两类依托于协议的API技术,RESTful API是一种架构,其通过HTTP和JSON进行传输,不需要存储或重新打包数据,同时支持TLS加密。

API组成要素

通信协议:API一般利用HTTPS等加密通讯协议进行数据传输,以确保数据交互安全。

域名:用于指向API在网络中的位置。API通常被部署在主域名或者专用域名之下,接入方可通过域名调用相关API。

版本号:不同版本的API可能存在巨大差异,尤其对于多版本并存、增量发布等情况,API版本号有助于准确区分API的参数设置。

路径:路径又称“终点”(endpoint),指表示API及API执行功能所需资源的具体地址。

请求方式:API常用的请求方式有GET、POST、PUT和DELETE四种,分别用于获取、更新、新建、删除指定资源。

请求参数:即传入参数,包含数据格式、数据类型、可否为空以及文字描述等内容。传入参数主要包括Cookie、Requestheader、请求body数据和地址栏参数等。

响应参数:即返回参数或传出参数,返回参数本身默认没有值,用于带出请求参数要求API后台所返回的数据。

接口文档:接口文档是记录API相关信息的文档,内容包括接口地址、请求方式、传入参数(请求参数)和响应参数等。

本文由@AG 发布于本站网站,未经授权禁止转载

更多行业知识,敬请关注本站行业知识栏目。

参考资料

《中国信通院:应用程序接口(API)数据安全研究报告(2020年)[57页].pdf》

推荐阅读

《7-字节跳动-字节API智能测试服务--ByQI-高玉军.pdf》

© 格特瑞咨询-验资网 版权所有 | 黔ICP备19002813号

免责声明:本站内容仅用于学习参考,信息和图片素材来源于互联网,如内容侵权与违规,请联系我们进行删除,我们将在三个工作日内处理。联系邮箱:303555158#QQ.COM (把#换成@)