接入指南

本指南将帮助您快速上手云开发 HTTP API，包括认证方式、基本使用流程和实际示例。

前提条件

在开始使用云开发 HTTP API 之前，请确保您满足以下条件：

• 云开发环境：拥有云开发平台的账户，如果您没有云开发环境，访问云开发并开通一个环境
• 技术基础：对 HTTP 协议和 RESTful API 设计原则有基本了解
• 开发环境：熟悉您选择的编程语言和开发环境
• 安全配置：如果希望从浏览器端调用，请确保您的环境已配置安全域名来放通跨域调用

认证和授权

调用云开发 HTTP API 需要进行认证和授权。请根据您的应用场景选择合适的认证方式：

1. AccessToken 认证

• 适用身份：用户身份
• 适用环境：客户端/服务端
• 描述：常用于客户端应用程序（如移动应用、Web 前端）访问后端服务，支持对用户身份进行精细的访问控制
• 获取方式：参考 获取 AccessToken

2. 腾讯云签名 V3 认证

• 适用身份：开发者身份
• 适用环境：服务端
• 描述：适用于服务器之间的通信，特别是需要高安全性的管理操作，如云资源的创建、更新和删除
• 限制：目前 数据模型 和 用户认证 接口不支持腾讯云签名 V3 认证
• 配置方式：参考 腾讯云签名 V3

使用 AccessToken 访问接口时，可以通过策略管理来控制用户及角色访问每个接口的权限。

使用示例

云函数调用示例

以下示例展示如何通过 HTTP API 调用云函数：

cURL

curl -X POST "https://your-env-id.api.tcloudbasegateway.com/v1/functions/YOUR_FUNCTION_NAME" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "张三",
    "age": 25
  }'

JavaScript

const response = await fetch(
  "https://your-env-id.api.tcloudbasegateway.com/v1/functions/YOUR_FUNCTION_NAME",
  {
    method: "POST",
    headers: {
      Authorization: "Bearer YOUR_ACCESS_TOKEN",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "张三",
      age: 25,
    }),
  }
);

const result = await response.json();
console.log("函数返回结果:", result);

Python

import requests
import json

def call_cloud_function():
    url = "https://your-env-id.api.tcloudbasegateway.com/v1/functions/YOUR_FUNCTION_NAME"
    headers = {
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
    }
    data = json.dumps({
        "name": "张三",
        "age": 25
    })

    response = requests.post(url, headers=headers, data=data)
    result = response.json()
    print("函数返回结果:", result)
    return result

成功调用云函数时，API 会返回以下格式的响应：

{
  "result": "函数执行结果",
  "requestId": "请求ID",
  "timestamp": 1640995200000
}

如果调用失败，错误响应格式类似这种：

{
  "code": "FUNCTION_PARAM_INVALID",
  "message": "xxxxx",
  "requestId": "yyxxxxxx-yyyy-yyyy-zzzz-xxxxxxzzyyyy"
}

云开发平台提供了在线调试工具，您可以在不编写代码的情况下测试 API 接口：

1. 访问接口文档页面
2. 找到调试工具入口
3. 填写环境 ID 和请求参数
4. 点击发送请求查看响应