IPFS Upload API — Täydellinen kehittäjäopas

Tiedostojen lataamisen IPFS:ään pitäisi olla yhtä yksinkertaista kuin POST-pyynnön tekemisen. Tässä oppaassa teet juuri sitä — lataat JSON-asiakirjoja, kuvia ja PDF-tiedostoja IPFS:ään käyttäen vain fetch()-funktiota ja API-avainta. Lopussa sinulla on täydellinen Node.js-skripti, joka lataa sisältöä, listaa tiedostoja, hakee metatietoja ja luo allekirjoitettuja tokeneita turvallisiin asiakaspuolen latauksiin. Uusi IPFS:ssä? Aloita kysymyksellä Mikä on IPFS Pinning? ymmärtääksesi perusteet ennen kuin sukellat koodiin.

Mitä rakennat

• Lataa JSON-objekti IPFS:ään ja saa takaisin sisällön tunniste (CID).
• Lataa binäärinen kuva levyltä.
• Liitä kuvauksia ja mukautettuja metatietoja latauksiin.
• Kysele lataushistoriaasi päivämääräalueen mukaan.
• Hae tietyn tiedoston tiedot.
• Luo aikarajoitettuja allekirjoitettuja tokeneita, jotta selain voi ladata suoraan paljastamatta API-avainta.
• Käsittele virheitä ja toteuta uudelleenyrityslogiikka.

Kaikki ajetaan yhtä perus-URL:ää vastaan: https://api.ipfs.ninja

1. Asetus — Rekisteröidy ja hanki API-avain

1. Rekisteröidy ilmaiseksi tilille (luottokorttia ei tarvita).
2. Mene API Keys -kohtaan dashboardin sivupalkissa.
3. Klikkaa Create key, anna sille nimi ja kopioi avain heti — se ei näytetä uudelleen.

Avain näyttää tältä: bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6. Jokainen alla oleva esimerkki lähettää sen X-Api-Key-otsakkeessa.

2. Lataa JSON IPFS:ään

Yksinkertaisin lataus: välitä tavallinen JavaScript-objekti content-kenttänä, ja API serialisoi sen, kiinnittää sen IPFS:ään ja palauttaa CID:n.

// upload-json.mjs
const API = "https://api.ipfs.ninja";
const API_KEY = "bws_your_key_here";

const payload = {
  content: {
    name: "Galactic Badge #42",
    description: "Proof of attendance — Galactic Meetup 2026",
    attributes: [
      { trait_type: "Event", value: "Galactic Meetup" },
      { trait_type: "Year", value: 2026 }
    ]
  }
};

const res = await fetch(`${API}/upload/new`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-Api-Key": API_KEY
  },
  body: JSON.stringify(payload)
});

const data = await res.json();
console.log("CID :", data.cid);
console.log("Size:", data.sizeMB, "MB");
console.log("IPFS:", data.uris.ipfs);
console.log("URL :", data.uris.url);

Suorita komennolla node upload-json.mjs. Onnistunut vastaus näyttää tältä:

{
  "cid": "bafkreigx7gq...",
  "sizeMB": 0.0004,
  "uris": {
    "ipfs": "ipfs://bafkreigx7gq...",
    "url": "https://ipfs.ninja/ipfs/bafkreigx7gq..."
  }
}

url-kenttä osoittaa julkiseen HTTP-yhdyskäytävään, joten sisältö on välittömästi saavutettavissa missä tahansa selaimessa.

3. Lataa kuva

Binääritiedostot (kuvat, PDF:t, ääni) lähetetään base64-koodattuina merkkijonoina content-kentässä.

// upload-image.mjs
import { readFileSync } from "node:fs";

const API = "https://api.ipfs.ninja";
const API_KEY = "bws_your_key_here";

const imageBuffer = readFileSync("./photo.png");
const base64 = imageBuffer.toString("base64");

const res = await fetch(`${API}/upload/new`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-Api-Key": API_KEY
  },
  body: JSON.stringify({ content: base64 })
});

const data = await res.json();
console.log("Image CID:", data.cid);
console.log("Gateway  :", data.uris.url);

API tunnistaa MIME-tyypin automaattisesti — PNG, JPEG, WebP, GIF ja PDF kaikki tuetaan. Ylimääräisiä otsakkeita tai content-type-ylityksiä ei tarvita.

Curlilla sama toimenpide näyttää tältä:

BASE64=$(base64 -w 0 photo.png)

curl -X POST https://api.ipfs.ninja/upload/new \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: bws_your_key_here" \
  -d "{\"content\": \"$BASE64\"}"

4. Lataus metatiedoilla

Jokainen lataus hyväksyy kaksi valinnaista kenttää: description (vapaa tekstileiman) ja metadata (mielivaltaiset avain-arvo-parit). Molemmat tallennetaan CID:n viereen ja palautetaan, kun listaat tai haet tiedoston myöhemmin.

// upload-with-metadata.mjs
const API = "https://api.ipfs.ninja";
const API_KEY = "bws_your_key_here";

const res = await fetch(`${API}/upload/new`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-Api-Key": API_KEY
  },
  body: JSON.stringify({
    content: { title: "Meeting Notes", body: "Q1 roadmap recap..." },
    description: "Q1 2026 planning meeting notes",
    metadata: {
      project: "acme-app",
      author: "dana",
      version: "1"
    }
  })
});

const data = await res.json();
console.log("CID:", data.cid);

Metatiedot helpottavat tiedostojen suodattamista ja järjestämistä puolellasi ilman, että sinun tarvitsee jäsennellä IPFS-sisältöä itse.

5. Kiinnitä olemassa oleva CID

Jos sinulla on jo sisältöä IPFS:ssä ja haluat varmistaa, että se pysyy saatavilla, kiinnitä se CID:llä:

// pin-cid.mjs
const API = "https://api.ipfs.ninja";
const API_KEY = "bws_your_key_here";

const res = await fetch(`${API}/pin`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-Api-Key": API_KEY
  },
  body: JSON.stringify({
    cid: "bafkreigx7gq...",
    description: "Pinned from external source"
  })
});

const data = await res.json();
console.log("Pinned:", data.cid);

6. Listaa tiedostosi

Hae jokainen tiedosto, jonka olet ladannut aikaikkunan sisällä. Kyselyparametrit from ja to ovat Unix-aikaleimat millisekunteina.

// list-files.mjs
const API = "https://api.ipfs.ninja";
const API_KEY = "bws_your_key_here";

const now = Date.now();
const oneWeekAgo = now - 7 * 24 * 60 * 60 * 1000;

const url = `${API}/upload/list?from=${oneWeekAgo}&to=${now}`;

const res = await fetch(url, {
  headers: { "X-Api-Key": API_KEY }
});

const files = await res.json();

for (const file of files) {
  console.log(`${file.cid}  ${file.description ?? "(no description)"}`);
}

Curlilla:

FROM=$(($(date +%s) * 1000 - 604800000))
TO=$(($(date +%s) * 1000))

curl -s "https://api.ipfs.ninja/upload/list?from=$FROM&to=$TO" \
  -H "X-Api-Key: bws_your_key_here" | jq .

7. Hae tiedoston tiedot

Hae yksittäisen CID:n täydellinen tietue, mukaan lukien metatiedot, koko ja aikaleimat:

// get-file.mjs
const API = "https://api.ipfs.ninja";
const API_KEY = "bws_your_key_here";
const CID = "bafkreigx7gq...";

const res = await fetch(`${API}/file/${CID}`, {
  headers: { "X-Api-Key": API_KEY }
});

const details = await res.json();
console.log(JSON.stringify(details, null, 2));

8. Asiakaspuolen lataukset allekirjoitetuilla tokeneilla

API-avaimen upottaminen selainpakettiin on turvallisuusriski. Sen sijaan luo lyhytkestoinen allekirjoitettu token palvelimellasi ja välitä se asiakkaalle.

Palvelin (Express)

// server.mjs
import express from "express";

const app = express();
const API = "https://api.ipfs.ninja";
const API_KEY = process.env.IPFS_API_KEY;

app.post("/api/upload-token", async (req, res) => {
  const response = await fetch(`${API}/upload/signed-url`, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "X-Api-Key": API_KEY
    },
    body: JSON.stringify({
      name: "browser-upload",
      expiresIn: 600          // token valid for 10 minutes
    })
  });

  const { token, tokenId, expiresAt } = await response.json();
  res.json({ token, tokenId, expiresAt });
});

app.listen(3000, () => console.log("Server running on :3000"));

Selainasiakas

<!-- upload.html -->
<input type="file" id="filePicker" />
<button id="uploadBtn">Upload to IPFS</button>
<pre id="result"></pre>

<script>
  const API = "https://api.ipfs.ninja";

  document.getElementById("uploadBtn").addEventListener("click", async () => {
    // 1. Get a signed token from your own backend
    const tokenRes = await fetch("/api/upload-token", { method: "POST" });
    const { token } = await tokenRes.json();

    // 2. Read the selected file as base64
    const file = document.getElementById("filePicker").files[0];
    if (!file) return alert("Pick a file first");

    const base64 = await new Promise((resolve) => {
      const reader = new FileReader();
      reader.onload = () => resolve(reader.result.split(",")[1]);
      reader.readAsDataURL(file);
    });

    // 3. Upload directly to IPFS using the signed token
    const uploadRes = await fetch(`${API}/upload/new`, {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        "Authorization": `Signed ${token}`
      },
      body: JSON.stringify({
        content: base64,
        description: file.name
      })
    });

    const data = await uploadRes.json();
    document.getElementById("result").textContent = JSON.stringify(data, null, 2);
  });
</script>

Selain ei näe koskaan API-avaintasi. Allekirjoitettu token vanhentuu automaattisesti. Tokenit ovat moninkäyttöisiä — niitä voi käyttää useita kertoja, kunnes ne vanhenevat tai peruutetaan. useCount jäljitetään, mutta sitä ei valvota rajana.

9. Virheenkäsittely

API käyttää tavanomaisia HTTP-tilakoodeja. Tässä ne, jotka sinun tulisi käsitellä eksplisiittisesti:

Vastustuskykyinen latausfunktio eksponentiaalisella backoffilla:

// resilient-upload.mjs
const API = "https://api.ipfs.ninja";
const API_KEY = "bws_your_key_here";

async function uploadWithRetry(content, retries = 3) {
  for (let attempt = 1; attempt <= retries; attempt++) {
    const res = await fetch(`${API}/upload/new`, {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        "X-Api-Key": API_KEY
      },
      body: JSON.stringify({ content })
    });

    if (res.ok) return await res.json();

    const body = await res.text();

    if (res.status === 401) {
      throw new Error(`Authentication failed: ${body}`);
    }

    if (res.status === 413) {
      throw new Error(`Payload too large — reduce file size. ${body}`);
    }

    if (res.status === 429 || res.status >= 500) {
      const delay = Math.pow(2, attempt) * 1000;    // 2s, 4s, 8s
      console.warn(`Attempt ${attempt} failed (${res.status}). Retrying in ${delay}ms...`);
      await new Promise((r) => setTimeout(r, delay));
      continue;
    }

    throw new Error(`Upload failed (${res.status}): ${body}`);
  }

  throw new Error("Upload failed after all retries");
}

// Usage
const data = await uploadWithRetry({ hello: "world" });
console.log("CID:", data.cid);

10. Täydellinen toimiva esimerkki

Yksi skripti, joka harjoittaa jokaista tässä oppaassa käsiteltyä päätepistettä. Tallenna se nimellä ipfs-demo.mjs ja suorita komennolla node ipfs-demo.mjs.

// ipfs-demo.mjs
import { readFileSync } from "node:fs";

const API = "https://api.ipfs.ninja";
const API_KEY = "bws_your_key_here";

const headers = {
  "Content-Type": "application/json",
  "X-Api-Key": API_KEY
};

async function request(method, path, body) {
  const opts = { method, headers };
  if (body) opts.body = JSON.stringify(body);
  const res = await fetch(`${API}${path}`, opts);
  if (!res.ok) throw new Error(`${method} ${path} → ${res.status}: ${await res.text()}`);
  return res.json();
}

// --- 1. Upload JSON ---
console.log("--- Upload JSON ---");
const jsonResult = await request("POST", "/upload/new", {
  content: { name: "Demo Token", edition: 1 },
  description: "Tutorial demo — JSON upload",
  metadata: { tutorial: "true" }
});
console.log("CID:", jsonResult.cid);
console.log("URL:", jsonResult.uris.url);

// --- 2. Upload an image (if photo.png exists) ---
try {
  const img = readFileSync("./photo.png");
  console.log("\n--- Upload Image ---");
  const imgResult = await request("POST", "/upload/new", {
    content: img.toString("base64"),
    description: "Tutorial demo — image upload"
  });
  console.log("CID:", imgResult.cid);
  console.log("URL:", imgResult.uris.url);
} catch {
  console.log("\n--- Skipping image upload (no photo.png found) ---");
}

// --- 3. Pin the JSON CID ---
console.log("\n--- Pin CID ---");
const pinResult = await request("POST", "/pin", {
  cid: jsonResult.cid,
  description: "Pinned from tutorial"
});
console.log("Pinned:", pinResult.cid);

// --- 4. Get file details ---
console.log("\n--- File Details ---");
const details = await request("GET", `/file/${jsonResult.cid}`);
console.log(JSON.stringify(details, null, 2));

// --- 5. List recent files ---
console.log("\n--- Recent Files ---");
const now = Date.now();
const oneHourAgo = now - 60 * 60 * 1000;
const files = await request("GET", `/upload/list?from=${oneHourAgo}&to=${now}`);
console.log(`Found ${files.length} file(s) in the last hour`);
for (const f of files) {
  console.log(` - ${f.cid}  ${f.description ?? ""}`);
}

// --- 6. Create a signed upload token ---
console.log("\n--- Signed Token ---");
const tokenResult = await request("POST", "/upload/signed-url", {
  name: "demo-token",
  expiresIn: 300
});
console.log("Token ID :", tokenResult.tokenId);
console.log("Expires  :", new Date(tokenResult.expiresAt).toISOString());

// --- 7. Upload using the signed token ---
console.log("\n--- Upload with Signed Token ---");
const signedRes = await fetch(`${API}/upload/new`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": `Signed ${tokenResult.token}`
  },
  body: JSON.stringify({
    content: { note: "Uploaded with a signed token" }
  })
});
const signedData = await signedRes.json();
console.log("CID:", signedData.cid);

console.log("\nDone.");

Korvaa bws_your_key_here oikealla avaimella ja suorita skripti. Jokainen vaihe tulostaa tuloksensa, jotta voit seurata.

11. Seuraavat vaiheet

Tiedät nyt, miten ladata, kiinnittää, listata ja hakea tiedostoja IPFS Upload API:n kautta ja miten pitää selainlataukset turvallisina allekirjoitetuilla tokeneilla. Laajempaa katsausta varten, mukaan lukien dashboardin UI ja Python-esimerkit, katso Kuinka ladata tiedostoja IPFS:ään. Tästä eteenpäin:

• API-viite — Täydellinen päätepistedokumentaatio osoitteessa ipfs.ninja/docs.
• Mukautetut yhdyskäytävät — Tarjoa IPFS-sisältöä omasta verkkotunnuksesta. Katso yhdyskäytävän asetusopas.
• Analytiikka — Seuraa latausvolyymia, kaistanleveyttä ja kiinnityslukuja dashboardissa.
• HTTP-asiakas — SDK:ta ei vaadita. Voit käyttää standardia fetch():ää tai mitä tahansa HTTP-asiakasta API:n kanssa kommunikointiin.

Jos kohtaat ongelmia, avaa lippu osoitteessa support.ipfs.ninja tai liity yhteisöön Discordissa.