Typesense 中文文档

# 认证

本节介绍如何通过 Typesense Cloud 集群管理 API 进行认证。

如果您需要查看 Typesense Server API 文档，请参阅此处。

# 获取 API 密钥

  1. 登录 Typesense Cloud
  2. 使用右上角的账户切换器，切换到您要为其生成 API 密钥的账户
  3. 导航至您的账户页面 (opens new window)
  4. 滚动到页面底部，点击"需要以编程方式创建集群"旁边的"阅读更多"链接
  5. 在下一页上，点击"新建集群管理 API 密钥"

请务必记下此 API 密钥，因为这是您唯一一次能够查看完整 API 密钥的机会。

# 发起 API 调用

您可以将 API 密钥设置在 X-TYPESENSE-CLOUD-MANAGEMENT-API-KEY HTTP 头中，也可以使用相同的名称作为查询参数。

curl -X GET --location "https://cloud.typesense.org/api/v1/clusters" \
    -H "Accept: application/json" \
    -H "X-TYPESENSE-CLOUD-MANAGEMENT-API-KEY: INSERT-YOUR-KEY-HERE"

← 集群管理 →