त्वरित शुरुआत

दो मिनट से कम समय में अपनी पहली फ़ाइल IPFS पर अपलोड करें।

1. अपनी API key प्राप्त करें

अपने Google खाते से ipfs.ninja पर साइन अप करें। एक डिफ़ॉल्ट API key स्वचालित रूप से बनाई जाती है। अपनी API key देखने और प्रबंधित करने के लिए अपने प्रोफ़ाइल पेज पर जाएं।

WARNING

नोट: API key की समय सीमा समाप्त नहीं होती। आप कई key बना सकते हैं और उन्हें प्रोफ़ाइल पेज से अलग-अलग रद्द कर सकते हैं।

2. फ़ाइल अपलोड करें

अपनी सामग्री के साथ /upload/new पर POST अनुरोध भेजें। यहां 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 CID, फ़ाइल का आकार और एक्सेस URI लौटाता है:

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

3. अपनी फ़ाइल पुनः प्राप्त करें

अपनी फ़ाइल को दो तरीकों से एक्सेस करें:

IPFS gateway के माध्यम से (सार्वजनिक, प्रमाणीकरण की आवश्यकता नहीं)

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

API के माध्यम से (फ़ाइल मेटाडेटा लौटाता है)

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

प्रतिक्रिया:

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

अगले कदम

• API संदर्भ — सभी endpoints, पैरामीटर और त्रुटि कोड के लिए पूर्ण दस्तावेज़ीकरण।
• समर्पित Gateway — एक निजी gateway प्राप्त करें जो केवल आपकी फ़ाइलें सर्व करता है। Nirvana प्लान पर उपलब्ध।