概述
Quicknode 管理 API允许用户通过 REST API 以编程方式执行用户仪表盘中所有可用的操作。这些操作包括：
- 创建、管理和删除端点
- 检索指标和计费信息
- API密钥的管理与轮换
- 配置安全功能（例如：白名单、JWT 身份验证等）
API 规范（OpenAPI）
访问
管理 API 仅向订阅了付费套餐的账户开放。
身份验证
要使用管理 API，您必须在 HTTP 头中包含 API 密钥，以对请求进行身份验证。请按照以下步骤操作：
- 在Quicknode 控制台中生成一个 API 密钥。
- 在
x-api-keyHTTP 请求的头部。例如：
x-api-key: 此处填写您的 API 密钥
以下是一个使用 cURL 通过 Admin API 请求使用情况数据的示例：
curl -X GET 'https://api.quicknode.com/v0/usage/rpc' \
-H 'accept: application/json' \
-H 'x-api-key: 您的API密钥'
普罗米修斯导出器（企业版专属）
企业客户现在可以使用一个专用的端点—— Prometheus (/exporter/prometheus) — 以更深入地了解其 API 使用情况。该端点提供可无缝集成到内部仪表板中的实时指标。它提供的数据与 指标仪表盘，这些数据会按照 Quicknode 定义的间隔进行更新，并与任何 Prometheus 采集器兼容。这使得能够轻松、准确地监控和追踪使用指标。
请注意，该端点目前仅面向企业版客户开放。如需了解更多信息或咨询如何访问这些端点，欢迎随时联系我们。
发送管理 REST API 请求
在本文档中，您将看到针对每个受支持的 Admin API 方法，使用 cURL 以及各种编程语言发出的示例请求。本节将说明如何在您的机器上执行这些操作。
cURL
大多数基于 *nix 的系统默认都支持 cURL。cURL 是一个用于通过 URL 传输数据的命令行工具和库。请运行以下命令检查是否已安装：
curl -h
Quicknode 命令行界面
要运行 Quicknode CLI 示例，请安装 qn 命令行工具：
brew 安装 quicknode/tap/qn
请运行以下命令，检查是否已安装：
qn --version
然后使用您在Quicknode 控制面板中获取的 Admin API 密钥进行身份验证：
qn 身份验证 登录
您也可以直接提供 API 密钥：
qn auth login --api-key 您的API密钥
有关其他安装方法、输出格式和配置选项，请参阅Quicknode CLI 文档。
Python
要运行我们的 Python 代码示例，您需要安装 Python 以及 requests 包。您可以使用以下命令安装该包：
python -m pip install requests
JavaScript
要运行我们的 JavaScript 代码示例，您需要安装 Node v18 及以上版本。您可以按照这份官方文档的指引，全局安装最新稳定版的 Node。请运行以下命令检查是否已安装：
节点 -v
Ruby
要运行我们的 Ruby 代码示例，您需要安装 Ruby。您可以参考这份官方安装文档以获取更多信息。请运行以下命令检查是否已安装：
ruby -v
Quicknode SDK
要运行 Quicknode SDK 示例，请安装您所选语言的 SDK 包，在Quicknode 控制台中创建一个 API 密钥，并在您的环境中设置该密钥：
导出 QN_SDK__API_KEY="您的API密钥"
安装 Node.js SDK 软件包：
npm 安装 @quicknode/sdk
然后初始化 SDK 并发送一个 Admin API 请求：
import { QuicknodeSdk } from "@quicknode/sdk";
const qn = QuicknodeSdk.fromEnv();
const response = await qn.admin.getEndpoints({ limit: 20 });
console.log(response.data);
有关其他语言和配置选项，请参阅《Quicknode SDK 快速入门》。
我们 ❤️ 反馈
我们非常重视您的反馈！请花几分钟时间填写我们的Admin API 反馈表，并向我们分享您的想法。