Resumen
La API de administración de Quicknode permite a los usuarios realizar todas las acciones disponibles en el panel de control del usuario mediante programación a través de la API REST. Entre estas acciones se incluyen:
- Creación, gestión y eliminación de terminales
- Obtención de métricas e información de facturación
- Gestión y rotación de claves API
- Configuración de las funciones de seguridad (por ejemplo, listas blancas, autenticación JWT y otras)
Especificaciones de la API (OpenAPI)
Descarga las especificaciones de la API en formato legible por máquina para utilizarlas con herramientas compatibles (por ejemplo, Swagger Editor).
Acceso
La API de administración está disponible para las cuentas suscritas a planes de pago.
Autenticación
Para utilizar la API de administración, debes autenticar tus solicitudes incluyendo una clave de API en los encabezados HTTP. Sigue estos pasos:
- Genera una clave API desde tu panel de control de Quicknode.
- Incluye la clave de la API en el
x-api-keyencabezado de tu solicitud HTTP. Por ejemplo:
x-api-key: tu-clave-api-aquí
A continuación se muestra un ejemplo de cómo solicitar datos de uso mediante la API de administración con cURL:
curl -X GET 'https://api.quicknode.com/v0/usage/rpc' \
-H 'accept: application/json' \
-H 'x-api-key: TU_CLAVE_API_AQUÍ'
Prometheus Exporter (exclusivo para empresas)
Los clientes empresariales ya tienen acceso a un punto final exclusivo— Prometheus (/exporter/prometheus) — para obtener información más detallada sobre el uso de su API. Este punto final proporciona métricas en tiempo real que pueden integrarse fácilmente en los paneles de control internos. Ofrece los mismos datos que el cuadro de mando de métricas, se actualizan a intervalos definidos por Quicknode y son compatibles con cualquier scraper de Prometheus. Esto permite supervisar y realizar un seguimiento sencillo y preciso de las métricas de uso.
Ten en cuenta que, actualmente, este punto final solo está disponible para los clientes de Enterprise. Si necesitas más información o tienes alguna duda sobre cómo acceder a estos puntos finales, no dudes en ponerte en contacto con nosotros.
Realización de solicitudes a la API REST de administración
En esta documentación, encontrarás ejemplos de solicitudes realizadas con cURL y en distintos lenguajes de programación para cada método de la API de administración compatible. En esta sección se explica cómo ejecutarlas en tu equipo.
cURL
La mayoría de los sistemas basados en *nix son compatibles con cURL de serie. cURL es una herramienta de línea de comandos y una biblioteca para transferir datos mediante URL. Comprueba si la tienes ejecutando lo siguiente:
curl -h
Interfaz de línea de comandos de Quicknode
Para ejecutar los ejemplos de la CLI de Quicknode, instala el qn herramienta de línea de comandos:
preparar instalar quicknode/tap/qn
Comprueba si lo tienes ejecutando lo siguiente:
qn --versión
A continuación, autentícate con una clave de la API de administrador desde tu panel de control de Quicknode:
Inicio de sesión en QN Auth
También puedes introducir la clave de la API directamente:
qn auth login --api-key TU_CLAVE_API_AQUÍ
Para conocer otros métodos de instalación, formatos de salida y opciones de configuración, consulta la documentación de la CLI de Quicknode.
Python
Para ejecutar nuestros ejemplos de código en Python, necesitarás tener instalado Python, así como el paquete «requests». Puedes instalar este paquete con el siguiente comando:
python -m pip install requests
JavaScript
Para ejecutar nuestros ejemplos de código JavaScript, necesitarás tener instalado Node v18 o una versión posterior. Puedes seguir este documento oficial para instalar globalmente la última versión estable de Node. Comprueba si lo tienes ejecutando lo siguiente:
nodo -v
Rubí
Para ejecutar nuestros ejemplos de código en Ruby, necesitarás tener Ruby instalado. Puedes consultar este documento oficial de instalación para obtener más información. Comprueba si lo tienes ejecutando lo siguiente:
ruby -v
SDK de Quicknode
Para ejecutar los ejemplos del SDK de Quicknode, instala el paquete del SDK para tu lenguaje preferido, crea una clave de API en el panel de control de Quicknode y configúrala en tu entorno:
exportar QN_SDK__API_KEY="TU_CLAVE_API"
Instala el paquete SDK de Node.js:
npm instalar @quicknode/sdk
A continuación, inicializa el SDK y realiza una solicitud a la API de administración:
import { QuicknodeSdk } from "@quicknode/sdk";
const qn = QuicknodeSdk.fromEnv();
const response = await qn.admin.getEndpoints({ limit: 20 });
console.log(response.data);
Para conocer otros idiomas y opciones de configuración, consulta la Guía de inicio rápido del SDK de Quicknode.
Nos encantan los comentarios ❤️
¡Valoramos mucho tus comentarios! Dedica unos minutos a rellenar nuestro formulario de comentarios sobre la API de administración y comparte tu opinión con nosotros.