Overzicht
Quicknode's decentralized storage solution allows you to upload, store, manage, and retrieve data on the IPFS, InterPlanetary File System, network. IPFS ensures data integrity, mitigates risks, and offers improved performance and resilience. With Quicknode's IPFS REST API, you can connect seamlessly to the IPFS network and utilize the following APIs:
- Gateway: Create and manage gateway from the IPFS network through the gateway API.
- Pinning: Pin, view and manage pinned content to ensure its availability.
- Account: Fetch account usage information, including bandwidth and storage metrics.
API-specificaties (OpenAPI)
Download de machinaal leesbare API-specificaties voor gebruik met compatibele tools (bijvoorbeeld Swagger Editor).
The IPFS REST API Endpoint
To interact with the IPFS REST API, the following API endpoint is used:
https://api.quicknode.com/ipfs/rest
Authenticatie
To authenticate with the IPFS REST API, an API key is required to be sent with each request in the HTTP headers, you must first generate an API key. This key will serve as an authentication mechanism for your requests and should be included as an x-api-key header as shown below:
'x-api-key: your-api-key-here'
Making IPFS REST API Requests
In this documentation, you will see example requests made with cURL and various programming languages for each supported IPFS method. This section will explain how to execute it on your machine.
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
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
To learn more about Quicknode Storage, check out the following guide: How to Create and Host a Blog on IPFS using Quicknode Storage
We ❤️ feedback
❓ We want to hear from you! Please take a few minutes to fill out our IPFS API feedback form and let us know what you currently think about it. This helps us further improve the documentation.