构造请求
本节介绍如何构造API调用请求。构造好的请求,您可以使用curl或者Postman等工具进行测试验证。
请求URI由如下部分组成。
{URI-scheme} :// {Endpoint} /? {query-string}
URI-scheme:表示用于传输请求的协议,当前所有API均采用HTTPS协议。
Endpoint:指定承载API服务端点的服务器域名(或IP)和端口,不同服务实例的Endpoint不同,您可以从控制台菜单「开发配置」>>「云端 API」中获取。
query-string:查询参数,分为公共参数和接口参数。公共参数是所有接口都需要传的参数,比如签名信息、时间戳等。接口参数是要调用的接口规定的参数比如接口名字(Action)等。
例如您需要在演示环境查询某个产品下的设备列表,需要使用演示环境的Endpoint(si-d6e8d812acb848958054.tuyacloud.com:8686),并查找对应的接口名字(QueryDevice)。拼起来如下:
https://xxxxxx.tuyacloud.com:8686/?Action=QueryDevice&SignatureNonce=8d6131cab4e6465d975ba65ba4d45aad&AccessKeyId=xMr9wgwXQLhv5AUa65o03mcD&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-17T09:41:41Z&ProductKey=dwwAsxAkOwT7xhIY&Signature=Gg4HDRr8kYn2R0mYDI5hwOvrJDI%3D
在阅读下文时,您可以结合对照上面的请求示例进行理解
您可以在终端上使用curl命令进行测试验证。
curl https://xxxxxx.tuyacloud.com:8686/?Action=QueryDevice&SignatureNonce=8d6131cab4e6465d975ba65ba4d45aad&AccessKeyId=xMr9wgwXQLhv5AUa65o03mcD&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-17T09:41:41Z&ProductKey=dwwAsxAkOwT7xhIY&Signature=Gg4HDRr8kYn2R0mYDI5hwOvrJDI%3D
为构造API请求,您需要知道如何获取endpoint,以及如何拼接queryString
1.如何获取Endpoint
进入您的控制台。在菜单「开发配置」>>「云端 API」中获取
以演示环境为例:https://si-d6e8d812acb848958054.tuyacloud.com:3443/dev-info
登录用户名/密码:guest/guest@Tuyaiot
详细获取方法,参见获取Endpoint