api接口
什么是 API 接口？
API（Application Programming Interface）接口是一组规则和协议，它允许不同的软件组件之间相互通信。
简单来说 API 接口就像是一个快递员，它负责在不同的软件之间传递信息。打个比方，您在网上购物，当您点击“购买”按钮时，您的浏览器就会向电商网站的服务器发送一个请求，这个请求就像是一个快递订单。服务器收到请求后，会处理您的订单，并把处理结果（比如订单确认信息、商品发货信息等）通过 API 接口返回给你的浏览器，就像是快递员把包裹送到您手中一样
提示
视频介绍：点击跳转
API 接口分类
比如：操作系统 API、Web API、平台 API 等等。对于 Web API，它是一种通过网络访问后端系统的电子接口，其中可以包含一些众所周知的 Web 标准（如 HTTP、XML、JSON 等）。
API 接口的组成
- URL：请求的地址，比如：https://api.salesmartly.com
- HTTP 方法：请求的方式，比如：
GET、POST、PUT、DELETE等 - 请求头：请求的头部信息，比如：Content-Type、Authorization 等
- 请求体：请求的内容，比如：JSON、XML 等
请求方法
- GET：获取资源
- POST：创建资源
- PUT：更新资源
- DELETE：删除资源
请求参数
查询参数：位于 URL 的?符号之后,在 URL 中以 ? 开头，多个参数之间用 & 连接，比如获取客户列表：https://api.salesmartly.com/api/chat-user/get-contact-list?project_id=fj3mnx&updated_time={"start":1680000000,"end":1714027206}
提示
更多参数请参考api 参数传递
响应
响应（Response）是服务器返回给客户端的数据，以回应客户端发送的请求。响应通常包含了请求的处理结果、状态码、响应头部和响应体等信息，客户端根据这些信息来进行后续的处理，API 接口处理请求后返回的数据，通常以 JSON 或 XML 格式返回，包括状态码、响应头和响应体等信息。
- 状态码：表示请求的状态，比如：200、404、500 等
- 响应头：响应的头部信息，比如：Content-Type、Authorization 等
- 响应体：响应的内容，比如：JSON、XML 等
响应状态码
- 200：请求成功
- 400：请求参数错误
- 401：未授权
- 403：禁止访问
- 404：未找到
- 500：表示服务器内部错误