Overzicht

Met de Quicknode Admin API kunnen gebruikers alle acties die in het gebruikersdashboard beschikbaar zijn, programmatisch uitvoeren via de REST API. Deze acties omvatten:

1. Eindpunten aanmaken, beheren en verwijderen
2. Statistieken en factuurgegevens opvragen
3. API-sleutels beheren en rouleren
4. Beveiligingsfuncties configureren (bijvoorbeeld whitelisting, JWT-authenticatie en meer)

API-specificaties (OpenAPI)

Download de machinaal leesbare API-specificaties voor gebruik met compatibele tools (bijvoorbeeld Swagger Editor).

• Beheer-API (OpenAPI)

Toegang

De Admin API is beschikbaar voor accounts met een betaald abonnement.

Authenticatie

Om de Admin API te kunnen gebruiken, moet u uw verzoeken verifiëren door een API-sleutel in de HTTP-headers op te nemen. Volg deze stappen:

1. Maak een API-sleutel aan via je Quicknode-dashboard.
2. Voeg de API-sleutel toe aan de x-api-key header van je HTTP-verzoek. Bijvoorbeeld:

x-api-key: je-api-sleutel-hier

Hier volgt een voorbeeld van hoe je gebruiksgegevens kunt opvragen via de Admin API met cURL:

curl -X GET 'https://api.quicknode.com/v0/usage/rpc' \
     -H 'accept: application/json' \
     -H 'x-api-key: UW_API-SLEUTEL_HIER'

Prometheus Exporter (exclusief voor Enterprise)

Zakelijke klanten hebben nu toegang tot een speciaal eindpunt— Prometheus (/exporter/prometheus) — voor meer inzicht in hun API-gebruik. Dit eindpunt biedt realtime statistieken die naadloos in interne dashboards kunnen worden geïntegreerd. Het biedt dezelfde gegevens als de dashboard met statistieken, die met door Quicknode vastgestelde tussenpozen worden bijgewerkt, en die compatibel zijn met elke Prometheus-scraper. Dit maakt het mogelijk om gebruiksstatistieken eenvoudig en nauwkeurig te monitoren en bij te houden.

Opmerking

Houd er rekening mee dat dit eindpunt momenteel alleen beschikbaar is voor Enterprise-klanten. Neem gerust contact met ons op voor meer informatie of vragen over de toegang tot deze eindpunten.

REST API-verzoeken uitvoeren voor beheerders

In deze documentatie vindt u voorbeelden van verzoeken die met cURL en verschillende programmeertalen zijn uitgevoerd voor elke ondersteunde Admin API-methode. In dit gedeelte wordt uitgelegd hoe u dit op uw computer kunt uitvoeren.

cURL

De meeste op *nix gebaseerde systemen bieden standaard ondersteuning voor cURL. cURL is een opdrachtregelprogramma en een bibliotheek voor het overbrengen van gegevens via URL’s. Controleer of je het hebt door het volgende uit te voeren:

curl -h

Quicknode-opdrachtregelinterface

Om de voorbeelden van de Quicknode-CLI uit te voeren, installeer je de qn opdrachtregelprogramma:

brouwen installeren quicknode/tap/qn

Controleer of je het hebt door het volgende uit te voeren:

qn --versie

Meld je vervolgens aan met een Admin API-sleutel vanuit je Quicknode-dashboard:

qn auth inloggen

Je kunt de API-sleutel ook rechtstreeks opgeven:

qn auth login --api-key UW_API-SLEUTEL_HIER

Raadpleeg de Quicknode CLI-documentatie voor andere installatiemethoden, uitvoerformaten en configuratieopties.

Python

Om onze Python-codevoorbeelden uit te voeren, moet je Python en het pakket `requests` hebben geïnstalleerd. Je kunt dit pakket met de volgende opdracht installeren:

python -m pip install requests

JavaScript

Om onze JavaScript-codevoorbeelden uit te voeren, moet Node v18 of hoger op je computer zijn geïnstalleerd. Je kunt dit officiële document volgen om de nieuwste, stabiele versie van Node globaal te installeren. Controleer of je deze versie hebt door het volgende uit te voeren:

knooppunt -v

Ruby

Om onze Ruby-codevoorbeelden uit te voeren, moet Ruby op je computer zijn geïnstalleerd. Raadpleeg deze officiële installatiehandleiding voor meer informatie. Controleer of je Ruby hebt geïnstalleerd door het volgende uit te voeren:

ruby -v

Quicknode SDK

Om de voorbeelden van de Quicknode SDK uit te voeren, installeer je het SDK-pakket voor de taal van je keuze, maak je een API-sleutel aan in het Quicknode-dashboard en stel je deze in je omgeving in:

exporteren QN_SDK__API_KEY="UW_API_SLEUTEL"

Installeer het Node.js SDK-pakket:

npm installeren @quicknode/sdk

Initialiseer vervolgens de SDK en voer een Admin API-verzoek uit:

import { QuicknodeSdk } from "@quicknode/sdk";

const qn = QuicknodeSdk.fromEnv();
const response = await qn.admin.getEndpoints({ limit: 20 });

console.log(response.data);

Raadpleeg de Quickstart-gids voor de Quicknode SDK voor andere talen en configuratieopties.

We ❤️ feedback

Wij stellen uw feedback zeer op prijs! Neem alstublieft een paar minuten de tijd om ons feedbackformulier voor de Admin API in te vullen en uw mening met ons te delen.