Бързо начало

Качете първия си файл в IPFS за по-малко от две минути.

1. Получете вашия API ключ

Регистрирайте се в ipfs.ninja с вашия Google акаунт. Стандартен API ключ се създава автоматично. Отидете на вашата страница Профил, за да прегледате и управлявате вашите API ключове.

WARNING

Забележка: API ключовете нямат срок на валидност. Можете да създавате множество ключове и да ги отменяте поединично от страницата Профил.

2. Качете файл

Изпратете POST заявка към /upload/new с вашето съдържание. Ето пример за качване на JSON обект:

curl

curl -X POST https://api.ipfs.ninja/upload/new \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "content": {
      "name": "My NFT",
      "description": "A permanent file on IPFS",
      "image": "ipfs://bafybeiExampleCID..."
    },
    "description": "NFT metadata"
  }'

JavaScript

const response = await fetch("https://api.ipfs.ninja/upload/new", {
  method: "POST",
  headers: {
    "X-Api-Key": "bws_your_api_key_here",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    content: {
      name: "My NFT",
      description: "A permanent file on IPFS",
      image: "ipfs://bafybeiExampleCID..."
    },
    description: "NFT metadata"
  })
});

const data = await response.json();
console.log(data.cid);       // "bafybeigdyrzt5..."
console.log(data.uris.url);  // "https://ipfs.ninja/ipfs/bafybeigdyrzt5..."

CIDv1 по подразбиране

Новите качвания произвеждат модерен CIDv1 (bafk… за малко съдържание в един блок, bafy… за по-големи файлове и директории) съгласно IPIP-0499. По-старите CID-ове Qm… от предишни качвания все още се разрешават навсякъде — и двата формата работят като вход за всяка крайна точка.

API-то връща CID, размер на файла и URI за достъп:

{
  "cid": "bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi",
  "sizeMB": 0.001,
  "uris": {
    "ipfs": "ipfs://bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi",
    "url": "https://ipfs.ninja/ipfs/bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi"
  }
}

3. Достъпете файла си

Достъпете файла си по два начина:

Чрез IPFS gateway (без нужда от удостоверяване)

curl https://ipfs.ninja/ipfs/bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi

TIP

Apex шлюзът https://ipfs.ninja/ipfs/<CID> обслужва CID-ове, качени или закачени от всеки потребител на IPFS Ninja. CID-ове, непознати на платформата, връщат HTTP 410 Gone — за тях използвайте публичен шлюз (ipfs.io, dweb.link) или първо изпълнете POST /pin на CID-а към акаунта си.

Чрез API (връща метаданни на файла)

curl https://api.ipfs.ninja/file/bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi \
  -H "X-Api-Key: bws_your_api_key_here"

Отговор:

{
  "cid": "bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi",
  "fileName": "NFT metadata",
  "fileType": "json",
  "sizeMB": 0.001,
  "createdAt": 1711036800000,
  "uris": {
    "ipfs": "ipfs://bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi",
    "url": "https://ipfs.ninja/ipfs/bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi"
  }
}

Алтернатива: Използвайте AWS SDK (S3-съвместим)

Вече използвате S3? Насочете съществуващия си AWS SDK към https://s3.ipfs.ninja и използвайте API ключа си като идентификационни данни:

import { S3Client, PutObjectCommand } from "@aws-sdk/client-s3";

const s3 = new S3Client({
  endpoint: "https://s3.ipfs.ninja",
  credentials: { accessKeyId: "bws_prefix", secretAccessKey: "bws_fullkey" },
  region: "us-east-1",
  forcePathStyle: true
});

await s3.send(new PutObjectCommand({
  Bucket: "my-project",
  Key: "my-file.json",
  Body: JSON.stringify({ hello: "IPFS" })
}));

Вижте S3 съвместимост за пълна документация с примери на Python, Go и за миграция.

Предпочитате да кликате? Използвайте таблото за управление

Ако предпочитате да не пишете код, ipfs.ninja/upload приема плъзгане и пускане (drag-and-drop) за:

• Произволен файл — пуснете го в зоната за качване, закача се + получавате CID
• Папка — пакетирана в UnixFS директория във вашия браузър, качена като единичен импорт, разрешава се на /ipfs/{cid}/{subpath} за всеки дъщерен файл
• .car архив — автоматично разпознат, главният CID се запазва точно (вижте CAR импорт)

След качването файловете се появяват на страницата с файлове, където можете да ги преименувате, да ги премествате между папки, да получите IPFS CID на директория за цяла папка (снимка) и да конфигурирате S3 CORS за отделен bucket за достъп чрез SDK в браузъра.

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

• Справка за API — Пълна документация за всички крайни точки, параметри и кодове за грешки.
• S3 съвместимост — Използвайте AWS SDK, за да взаимодействате с IPFS Ninja.
• Специализирани gateway-и — Получете частен gateway, който обслужва само вашите файлове.