WEBAPI 概念

WEBAPI 概念

为了开始使用Kesion WebAPI,我们将分解一些与API相关的关键概念和术语:
RESTful
URL

请求
响应
这些概念在使用和理解Kesion WebAPI方面都扮演着重要的角色。让我们简单地把它们分解一下,以便以后我们可以更深入地探讨它们。

RESTful

Kesion WebAPI采用RESTful 作为API标准,其具体实现遵循四个基本设计原则:

显式地使用 HTTP 方法(GET、POST)。

公开目录结构式的 URI。

传输 JavaScript Object Notation (JSON)。

URL

URL是访问API的最终地址,URL由域名 + webapi +接口路径组成,访问不同的URL将获取或修改不同的数据。

例如,通过URL
http://example.com/webapi/User/GetUserInfo可以获取到用户的列表,其中域名为 http://example.com/ ,接口路径为/webapi/User/GetUserInfo。

URL可以带参数,例如,通过URL http://example.com/webapi/User/GetUserInfo?userid=1 可以获取用户Id为1的信息。

请求

可以向 Kesion API发起GET, POST 两种不同的请求,每种请求的含义如下:

功能类型

读取GET

创建POST

响应

响应是你从REST API返回的数据,响应可以返回所需的数据,也可以用来返回错误。