빠른 시작

2분 이내에 첫 번째 파일을 IPFS에 업로드하세요.

1. API 키 받기

Google 계정으로 ipfs.ninja에 가입하세요. 기본 API 키가 자동으로 생성됩니다. 프로필 페이지에서 API 키를 확인하고 관리하세요.

WARNING

참고: API 키는 만료되지 않습니다. 여러 개의 키를 생성하고 프로필 페이지에서 개별적으로 폐기할 수 있습니다.

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 게이트웨이를 통해 (공개, 인증 불필요)

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 레퍼런스 — 모든 엔드포인트, 매개변수, 오류 코드에 대한 전체 문서입니다.
• 전용 게이트웨이 — 자신의 파일만 제공하는 프라이빗 게이트웨이를 받으세요. Nirvana 플랜에서 사용 가능합니다.