Bắt đầu nhanh

Tải lên tệp đầu tiên của bạn lên IPFS trong vòng chưa đầy hai phút.

1. Lấy khóa API của bạn

Đăng ký tại ipfs.ninja bằng tài khoản Google của bạn. Một khóa API mặc định sẽ được tạo tự động. Truy cập trang Hồ sơ của bạn để xem và quản lý các khóa API.

WARNING

Lưu ý: Khóa API không hết hạn. Bạn có thể tạo nhiều khóa và thu hồi chúng riêng lẻ từ trang Hồ sơ.

2. Tải lên tệp

Gửi yêu cầu POST đến /upload/new với nội dung của bạn. Đây là ví dụ tải lên một đối tượng 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://QmExampleCID..."
    },
    "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://QmExampleCID..."
    },
    description: "NFT metadata"
  })
});

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

API trả về CID, kích thước tệp và URI truy cập:

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

3. Truy xuất tệp của bạn

Truy cập tệp của bạn theo hai cách:

Qua gateway IPFS (công khai, không cần xác thực)

curl https://ipfs.ninja/ipfs/QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN

Qua API (trả về siêu dữ liệu tệp)

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

Phản hồi:

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

Bước tiếp theo

• Tham chiếu API — Tài liệu đầy đủ cho tất cả các endpoint, tham số và mã lỗi.
• Gateway Chuyên dụng — Nhận gateway riêng tư chỉ phục vụ các tệp của bạn. Có sẵn trong gói Nirvana.