IPFS Upload API — Пълен наръчник за разработчици

Качването на файлове в IPFS трябва да бъде толкова просто, колкото изпращането на POST заявка. В този наръчник ще направите точно това — ще качите JSON документи, изображения и PDF файлове в IPFS с нищо повече от fetch() и API ключ. Накрая ще имате пълен Node.js скрипт, който качва съдържание, изброява файлове, извлича метаданни и генерира подписани токени за сигурни качвания от клиента. Нов в IPFS? Започнете с Какво е IPFS Pinning?, за да разберете основите, преди да се потопите в кода.

Какво ще изградите

• Качете JSON обект в IPFS и получете обратно идентификатор на съдържанието (CID).
• Качете двоично изображение от диска.
• Прикачете описания и персонализирани метаданни към качванията.
• Запитайте историята на качванията по диапазон от дати.
• Извлечете подробности за конкретен файл.
• Създайте подписани токени с ограничено време, така че браузърът да може да качва директно, без да излага вашия API ключ.
• Обработете грешки и реализирайте логика за повторни опити.

Всичко работи срещу един основен URL: https://api.ipfs.ninja

1. Настройка — Регистрация и получаване на API ключ

1. Регистрирайте се за безплатен акаунт (не се изисква кредитна карта).
2. Отидете на API Keys в страничната лента на таблото.
3. Кликнете върху Create key, дайте му име и веднага копирайте ключа — повече няма да бъде показан.

Вашият ключ изглежда така: bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6. Всеки пример по-долу го изпраща в заглавката X-Api-Key.

2. Качване на JSON в IPFS

Най-простото качване: подайте обикновен JavaScript обект като content и API-то го сериализира, закача го в IPFS и връща CID.

// 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);

Стартирайте с node upload-json.mjs. Успешен отговор изглежда така:

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

Полето url сочи към публичен HTTP gateway, така че съдържанието е незабавно достъпно във всеки браузър.

3. Качване на изображение

Двоични файлове (изображения, PDF, аудио) се изпращат като base64-кодирани низове в полето content.

// 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-то автоматично разпознава MIME типа — PNG, JPEG, WebP, GIF и PDF се поддържат всички. Не са необходими допълнителни заглавки или подмени на content-type.

С curl същата операция изглежда така:

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. Качване с метаданни

Всяко качване приема две незадължителни полета: description (етикет със свободен текст) и metadata (произволни двойки ключ-стойност). И двете се запазват редом с CID и се връщат, когато по-късно изброите или извлечете файла.

// 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);

Метаданните улесняват филтрирането и организирането на файлове от ваша страна, без да анализирате самото IPFS съдържание.

5. Закачане на съществуващ CID

Ако вече имате съдържание в IPFS и искате да гарантирате, че остава достъпно, закачете го по CID:

// 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. Изброяване на вашите файлове

Извлечете всеки файл, който сте качили в рамките на времеви прозорец. Параметрите на заявката from и to са Unix времеви маркери в милисекунди.

// 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)"}`);
}

С curl:

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. Подробности за файл

Извлечете пълния запис за един CID, включително метаданни, размер и времеви маркери:

// 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. Качвания от клиента с подписани токени

Вграждането на API ключ в bundle на браузъра е риск за сигурността. Вместо това генерирайте кратко-валиден подписан токен на вашия сървър и го предайте на клиента.

Сървър (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"));

Клиент в браузъра

<!-- 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>

Браузърът никога не вижда вашия API ключ. Подписаният токен изтича автоматично. Токените са многократни — могат да се използват многократно, докато не изтекат или не бъдат отменени. useCount се проследява, но не се прилага като ограничение.

9. Обработка на грешки

API-то използва конвенционални HTTP статус кодове. Ето тези, които трябва да обработвате изрично:

Устойчива функция за качване с експоненциален backoff:

// 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. Пълен работещ пример

Един скрипт, който упражнява всеки endpoint, разгледан в този наръчник. Запазете го като ipfs-demo.mjs и стартирайте с 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.");

Заменете bws_your_key_here с реален ключ и стартирайте скрипта. Всяка стъпка отпечатва своя резултат, за да можете да следите.

11. Следващи стъпки

Сега знаете как да качвате, закачате, изброявате и извличате файлове през IPFS Upload API и как да поддържате браузърните качвания сигурни с подписани токени. За по-широк преглед, включително UI на таблото и Python примери, вижте Как да качвате файлове в IPFS. Ето къде да отидете оттук:

• API Reference — Пълна документация на endpoint-ите на ipfs.ninja/docs.
• Персонализирани gateway-и — Сервирайте IPFS съдържание от вашия собствен домейн. Вижте ръководство за настройка на gateway.
• Аналитика — Проследявайте обема на качванията, пропускателна способност и брой закачания в таблото.
• HTTP клиент — Не е необходимо SDK. Можете да използвате стандартния fetch() или който и да е HTTP клиент за взаимодействие с API-то.

Ако срещнете проблеми, отворете тикет на support.ipfs.ninja или се присъединете към общността в Discord.