文档首页/ 华为云WeLink/ 客户端用户指南/ Windows端/ 圆桌/ 圆桌API参考/ 如何调用API/ 构造请求
更新时间：2024-07-16 GMT+08:00
查看PDF
分享

构造请求

本节介绍REST API请求的组成，并以创建事件接口说明如何调用API，以及使用该API创建一个事件实例。

请求URI

请求URI由如下部分组成。

{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}

尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。

表1 URI中的参数说明

参数

描述

URI-scheme

表示用于传输请求的协议，当前所有API均采用HTTPS协议。

Endpoint

指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点中获取。例如圆桌服务在“华北-北京四”区域的Endpoint为“roundtable.macroverse.huaweicloud.com”。

resource-path

资源路径，也即API访问路径。从具体API的URI模块获取，例如“创建事件”API的resource-path为“avatar/core/roundtable/services/v1/event/create”。

query-string

查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。

例如您需要获取事件流，则需使用的Endpoint（roundtable.macroverse.huaweicloud.com），并在创建事件的URI部分找到resource-path（avatar/core/roundtable/services/v1/event/create），拼接起来如下所示。

https://roundtable.macroverse.huaweicloud.com/avatar/core/roundtable/services/v1/event/create
图1 URI示意图

为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法

HTTP请求方法（也称为操作或动词）。它告诉服务你正在请求什么类型的操作。

表2 HTTP方法

方法

说明

GET

请求服务器返回指定资源。

PUT

请求服务器更新指定资源。

POST

请求服务器新增资源或执行特殊操作。

DELETE

请求服务器删除指定资源，如删除对象等。

HEAD

请求服务器资源头部。

PATCH

请求服务器更新资源的部分内容。

当资源不存在的时候，PATCH可能会去创建一个新的资源。

请求消息头

附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。

如下公共消息头需要添加到请求中。

表3 公共请求消息头

名称

描述

是否必选

示例

Content-Type

消息体的类型（格式），默认取值为“application/json”，有其他取值时会在具体接口中专门说明。

是

application/json

X-Auth-Token

用户Token，也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。

否

使用Token认证时该字段必选。

-

请求消息体（可选）

请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。

每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。

对于创建事件接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的帐号名称，********为用户登录密码，xxxxxxxxxx为project的名称，如cn-north-1，您可以从地区和终端节点中获取。

scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token额作用域为某个帐号下所有资源或帐号的某个project下的资源，详细定义请参见创建事件。

POST http://100.93.13.229:9091/apitest/avatar/platform/gateway/com.huawei.avatar:avatar_core/avatar/core/services/integrationDataService/createTopicEvent
Content-Type: application/json 

{
"content": "<div class=\"article-editor\"><p>测试</p>\n</div>",
"toUserAccount": [
"d00802009"
],
"privateRecipientAccount": [

],
"attachmentList": [

],
"source": 0,
"fromUserAccount": "d00802009",
"fromUserId": "1661999224792000000000000ac3c3816dcmaste",
"extraData": "{\"atSomeBodyList\":[],\"openFlag\":\"N\",\"openToAll\":\"N\",\"sendToAttentioner\":\"N\",\"sparkSource\":\"originality\",\"uuid\":\"076712d7-084e-4311-b61f-abd3f8034b26\"}",
"receiverTitle": "",
"themeIdList": [

],
"noFeedAccountList": [

],
"parentFeedId": "",
"eventTypeId": "E1001",
"label": [
"进行中"
],
"owner": [
""
],
"priority": "3",
"tagNameList": [

],
"extensionData": "{\"source\":\"\"}",
"businessFromName": "com.huawei.avatar",
"cardType": "C1001",
"eventTypeName": "消息",
"title": "",
"taskChargeUser": "",
"taskReminderTime": "",
"taskReminderContent": "您的任务快到期了，请及时处理",
"taskEndTime": null,
"fileDir": "",
"businessData": "{\"feedAssociation\":[]}",
"feedAllThemeMember": "N",
"sharingWelinkFlag": "0",
"sharingIMFlag": "0",
"mustReachData": {

},
"showReaded": "N",
"allowForwarding": "Y",
"allowSharing": "Y",
"allowLikes": "Y",
"allowShowBrowse": "N",
"allowDespise": "N",
"allowComments": "Y",
"allowAnonymousComments": "N",
"allowEdit": "Y",
"hideEventContent": "N",
"allowDespiseNotice": "N",
"allowPublicResult": "N",
"themeId": "e625278f242711ed8212fa163e3cdaeb"
}

到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于创建事件接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

父主题： 如何调用API

相关文档