API类型及应用

原创于 2024-09-19 09:22:33 发布 · 1.2k 阅读

10 ·

CC 4.0 BY-SA版权

文章标签：

#数据库 #java #开发语言 #前端 #php

API 专栏收录该内容

112 篇文章

订阅专栏

在当今数字化时代，API（应用程序编程接口）已成为连接不同软件和服务之间的桥梁，为应用程序提供了丰富的功能和数据。API的使用越来越广泛，它们不仅帮助开发者提高开发效率，还促进了系统集成和创新。本文将带你了解11种常见的API类型及其应用场景。

1. 公共API（Open API）

公共API对所有开发者开放，通常需要注册和使用API密钥。这些API侧重于让外部用户访问数据或服务，如Google Maps API。

2. 合作伙伴API（Partner API）

这类API仅对战略合作伙伴开放，需要特定的权限才能访问。它们通常通过API开发门户提供，允许合作伙伴在自助模式下访问。

3. 内部API（Private API）

内部API对外部用户隐藏，仅供公司内部不同开发团队之间使用，以提高生产率和重用服务。

4. 组合API（Composite API）

组合API通过API编排功能构建，允许开发者在一个调用中访问多个端点，适用于需要从多个服务中获取信息的场景。

5. 数据API（Data API）

数据API提供对底层数据集的CRUD（创建、读取、更新、删除）访问，常用于数据库或SaaS云服务。

6. 内部服务API（Internal Service API）

这类API反映内部流程的一部分或一些复杂的操作，通常用于公开内部服务。

7. 外部服务API（External Service API）

用于将第三方服务嵌入到公司现有的服务中，带来附加价值。

8. UX API（User Experience API）

利用复合API帮助应用程序开发人员为不同设备提供正确的用户体验。

9. REST API

REST API是现代Web应用程序的关键部分，遵循无状态、统一接口等原则。

10. SOAP API

SOAP API使用XML格式进行数据交换，适用于需要严格规则和标准的场景。

11. RPC API（Remote Procedure Call）

RPC API允许客户端在服务器上执行代码，是一种古老且简单的API类型。

公共参数 API测试接口

名称	类型	必须	描述
key	String	是	调用key（必须以GET方式拼接在URL中）
secret	String	是	调用密钥
api_name	String	是	API接口名称（包括在请求地址中）[item_search,item_get,item_search_shop等]
cache	String	否	[yes,no]默认yes，将调用缓存的数据，速度比较快
result_type	String	否	[json,jsonu,xml,serialize,var_export]返回数据格式，默认为json，jsonu输出的内容中文可以直接阅读
lang	String	否	[cn,en,ru]翻译语言，默认cn简体中文
version	String	否	API版本

响应参数

Version: Date:

名称	类型	示例值	描述
rate_content	String	衣服面料很好穿起来很舒服衣服挺合适的！	评论内容
rate_date	Date	2019-03-16 12:10:24	评论日期
pics	MIX	["//img.alicdn.com/bao/uploaded/i4/O1CN01Zmq4QI1dqwnpBIxmX_!!0-rate.jpg"]	评论图片
display_user_nick	String	李***0	买家昵称
auction_sku	String	颜色:加绒;尺码:2XL	评论商品属性
add_feedback	String	衣服面料很好穿起来很舒服衣服挺合适的！	追评内容
add_feedback_images	MIX	["//img.alicdn.com/bao/uploaded/i4/O1CN01Zmq4QI1dqwnpBIxmX_!!0-rate.jpg"]	追评图片
video	String	http://cloud.video.taobao.com/play/u/416a306c576e44524a75367539493165745863466b513d3d/p/1/d/sd/e/6/t/1/288913501300.mp4	视频地址

请求参数

请求参数：num_iid=652874751412&is_promotion=1

参数说明：num_iid:淘宝商品ID
is_promotion:是否获取取促销价

响应参数

Version: Date:2022-04-04

名称	类型	必须	示例值	描述
item	item[]	1		宝贝详情数据

	
-- 请求示例 url 默认请求参数已经URL编码处理
curl -i "https://api-gw.onebound.cn/taobao/item_get/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&num_iid=652874751412&is_promotion=1"

异常响应

{
    "error": "item-not-found",
    "reason": "商品没找到",
    "error_code": "2000",
    "success": 0,
    "cache": 0,
    "api_info": "today:0 max:10000",
    "execution_time": 0.081,
    "server_time": "Beijing/2020-06-10 23:44:00",
    "call_args": [],
    "api_type": "taobao",
    "request_id": "15ee0ffc041242"}

了解这些API类型及其应用场景对于开发者和技术爱好者来说非常重要，它们可以帮助你更有效地选择和使用API，以支持你的项目需求。无论是构建新的应用程序还是集成现有的服务，合适的API都是成功的关键。