Resumen
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.
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).
The IPFS REST API Endpoint
To interact with the IPFS REST API, the following API endpoint is used:
https://api.quicknode.com/ipfs/rest
Autenticación
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
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
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
To learn more about Quicknode Storage, check out the following guide: How to Create and Host a Blog on IPFS using Quicknode Storage
Nos encantan los comentarios ❤️
❓ 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.