IPFS Upload API — 完全な開発者チュートリアル

IPFS へのファイルアップロードは、POST リクエストを行うのと同じくらい簡単であるべきです。このチュートリアルでは、まさにそれを行います — fetch() と API キーだけで JSON ドキュメント、画像、PDF を IPFS にアップロードします。最後には、コンテンツをアップロードし、ファイルを一覧表示し、メタデータを取得し、安全なクライアントサイドアップロード用の署名付きトークンを生成する完全な 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 ゲートウェイを指しているため、コンテンツはすぐにどのブラウザでもアクセス可能です。

3. 画像をアップロード

バイナリファイル(画像、PDF、オーディオ)は、content フィールドに base64 エンコードされた文字列 として送信されます。

// 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. メタデータ付きアップロード

すべてのアップロードは 2 つのオプションフィールドを受け付けます: 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 キーを埋め込むことはセキュリティリスクです。代わりに、サーバー上で短命の 署名付きトークン を生成し、クライアントに渡します。

サーバー(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 ステータスコードを使用します。明示的に処理すべきものは次のとおりです:

指数バックオフによる耐障害性のあるアップロード関数:

// 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. 完全な動作例

このチュートリアルでカバーされたすべてのエンドポイントを実行する単一のスクリプト。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 リファレンス — ipfs.ninja/docs の完全なエンドポイントドキュメント。
• カスタムゲートウェイ — 自分のドメインから IPFS コンテンツを配信します。ゲートウェイ設定ガイドを参照してください。
• アナリティクス — ダッシュボードでアップロードボリューム、帯域幅、ピン数を追跡します。
• HTTP クライアント — SDK は不要です。標準の fetch() または任意の HTTP クライアントを使用して API と対話できます。

問題が発生した場合は、support.ipfs.ninja でチケットを開くか、Discord でコミュニティに参加してください。