跳转到主要内容

REST API 操作的认证设置

```html

摘要

本文档介绍了如何在 Astra 中为 REST API 操作配置身份验证。它涵盖了支持的身份验证方法、何时使用它们以及如何正确设置它们,以便您的 API 请求能够被接受。

说明

身份验证告知外部系统来自 Astra 的请求是允许的。在设置 REST API 操作时,您可以根据 API 的要求选择一种支持的身份验证方法。

Astra 目前支持以下身份验证选项:

  • API 密钥身份验证

  • 基本身份验证

  • 无身份验证

API 密钥身份验证

这是现代 API 最常用的身份验证方法。

使用 API 密钥身份验证时,您会在请求头中发送一个密钥或令牌。

您需要提供的内容

  • auth_key:HTTP 头部的名称(例如,AuthorizationX-API-Key

  • auth_value:在头部中发送的值(例如,Bearer your-token

常见模式

服务类型

头部名称

头部值格式

大多数 API

Authorization

Bearer your-token

自定义 API

X-API-Key

your-api-key

Webhook 服务

X-Webhook-Secret

your-secret

请确保头部名称和值与您的 API 文档要求完全一致。

基本身份验证

基本身份验证通常用于较旧的或遗留的系统。使用此方法:

  • 您需要提供用户名和密码

  • Astra 会使用标准的 HTTP 基本身份验证发送这些凭据

无身份验证

一些公共 webhook 端点不需要任何身份验证。

成功设置的技巧

  • 在 API 文档中确认所需的身份验证方法

  • 仔细检查头部名称、值和令牌格式

  • 保存后测试 REST API 操作,以确保身份验证正常工作

选择正确的身份验证方法可确保您的 REST API 操作顺利且安全地运行。

```

这是否解答了您的问题?