项目 HTTP API

约 4126 字大约 14 分钟

项目 HTTP API

准备工作

获得项目 API 接入地址

在 ThingsCloud 控制台的项目中，进入任意设备的详情页，在连接页面中可以找到 应用端 API 接入点，请使用 https 加密访问，确保数据安全性。

不同项目的 API 接入点可能不同，请您以控制台获取的地址为准。

创建 API 应用

在正式使用 API 之前，您还需要进入 ThingsCloud 控制台 > 项目应用，创建 API 类型的项目应用，获得 AppID 和 API Key，用于请求 API 时的身份验证。

API 请求代码示例

以获取 API AccessToken 为例，以下是常用编程语言请求 API 的示例代码，仅供参考：

NodeJS

const axios = require('axios');

const postData = {
  app_id: '<app_id>',
  access_key: '<access_key>',
  secret_key: '<secret_key>'
};

axios.post('https://<api-endpoint>/api/v1/access_token', postData, {
  headers: {
    'Content-Type': 'application/json'
  }
})
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.error(error);
  });

Python

import requests
import json

url = 'https://<api-endpoint>/api/v1/access_token'
data = {
    'app_id': '<app_id>',
    'access_key': '<access_key>',
    'secret_key': '<secret_key>'
}
headers = {
    'Content-Type': 'application/json'
}
response = requests.post(url, data=json.dumps(data), headers=headers)

print(response.text)

PHP

<?php
$api_url = 'https://<api-endpoint>/api/v1/access_token';

$data = array(
    'app_id' => '<app_id>',
    'access_key' => '<access_key>',
    'secret_key' => '<secret_key>'
);
$payload = json_encode($data);

$ch = curl_init($api_url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    'Content-Type: application/json'
));

$result = curl_exec($ch);

curl_close($ch);

echo $result;

?>

package main

import (
    "bytes"
    "encoding/json"
    "net/http"
)

func main() {
    url := "https://<api-endpoint>/api/v1/access_token"
    data := map[string]string{"app_id": "<app_id>", "access_key": "<access_key>", "secret_key": "<secret_key>"}
    payload, _ := json.Marshal(data)
    req, _ := http.NewRequest("POST", url, bytes.NewBuffer(payload))
    req.Header.Set("Content-Type", "application/json")
    client := &http.Client{}
    resp, _ := client.Do(req)
    defer resp.Body.Close()
}

Java

import java.net.HttpURLConnection;
import java.net.URL;
import java.io.OutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;

public class APICallExample {
    public static void main(String[] args) {
        try {
            // 设置 API 地址
            URL url = new URL("https://<api-endpoint>/api/v1/access_token");

            // 打开连接
            HttpURLConnection conn = (HttpURLConnection) url.openConnection();
            conn.setDoOutput(true);
            conn.setRequestMethod("POST");
            conn.setRequestProperty("Content-Type", "application/json");

            // 设置请求正文
            JSONObject jsonInput = new JSONObject();
            jsonInput.put("app_id", "<app_id>");
            jsonInput.put("access_key", "<access_key>");
            jsonInput.put("secret_key", "<secret_key>");
            String input = jsonInput.toString();
            OutputStream os = conn.getOutputStream();
            os.write(input.getBytes());
            os.flush();

            // 处理返回结果
            BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
            String output;
            while ((output = br.readLine()) != null) {
                System.out.println(output);
            }

            // 关闭连接
            conn.disconnect();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

C-Sharp

using System;
using System.IO;
using System.Net;
using System.Text;
using Newtonsoft.Json;

class APICallExample
{
    static void Main(string[] args)
    {
        var request = (HttpWebRequest)WebRequest.Create("https://<api-endpoint>/api/v1/access_token");
        request.Method = "POST";
        request.ContentType = "application/json";

        var payload = new
        {
            app_id = "<app_id>",
            access_key = "<access_key>",
            secret_key = "<secret_key>"
        };
        var jsonPayload = JsonConvert.SerializeObject(payload);

        using (var streamWriter = new StreamWriter(request.GetRequestStream()))
        {
            streamWriter.Write(jsonPayload);
            streamWriter.Flush();
            streamWriter.Close();
        }

        var response = (HttpWebResponse)request.GetResponse();
        var responseStream = response.GetResponseStream();
        var streamReader = new StreamReader(responseStream);
        var responseText = streamReader.ReadToEnd();

        Console.WriteLine(responseText);
    }
}

获取 AccessToken

通过身份验证 API，获得 AccessToken，用于所有 API 请求的身份标识。

提示

请注意，项目 HTTP API 中的 AccessToken 不是设备证书中的 AccessToken，它们只是名字相同，没有任何关系，请勿混用。

身份验证支持以下两种方式：

服务器获取 AccessToken

通过服务器发起请求，获取 AccessToken。这种方式，API 密钥保存在服务器，可有效防止泄露。

AccessToken 获取后的有效期为 1 天，过期后请重新获取。

Request Syntax

POST /api/v1/access_token HTTP/1.1
Content-Type: application/json

Request Body

{
	"app_id": "string",
	"access_key": "string",
	"secret_key": "string"
}

app_id：在控制台项目应用中获取。
access_key：在控制台项目应用中获取。
secret_key：在控制台项目应用中获取。