Ātrais sākums

Augšupielādējiet savu pirmo failu IPFS mazāk nekā divās minūtēs.

1. Iegūstiet savu API atslēgu

Reģistrējieties vietnē ipfs.ninja ar savu Google kontu. Noklusējuma API atslēga tiek izveidota automātiski. Dodieties uz savu Profila lapu, lai skatītu un pārvaldītu savas API atslēgas.

WARNING

Piezīme: API atslēgas nebeidzas. Varat izveidot vairākas atslēgas un atsaukt tās atsevišķi no savas Profila lapas.

2. Augšupielādējiet failu

Nosūtiet POST pieprasījumu uz /upload/new ar savu saturu. Šeit ir piemērs JSON objekta augšupielādei:

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 atgriež CID, faila izmēru un piekļuves URI:

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

3. Izgūstiet savu failu

Piekļūstiet savam failam divos veidos:

Caur IPFS gateway (publisks, autentifikācija nav nepieciešama)

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

Caur API (atgriež faila metadatus)

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

Atbilde:

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

Nākamie soļi

• API atsauce — Pilna dokumentācija par visiem galapunktiem, parametriem un kļūdu kodiem.
• Veltīti gateway — Iegūstiet privātu gateway, kas apkalpo tikai jūsu failus. Pieejams Nirvana plānā.