Épinglage

Épinglez du contenu IPFS existant sur votre compte. Lorsque vous épinglez un CID, notre cluster récupéré le contenu du réseau IPFS et le maintient disponible en permanence.

Épingler par CID

POST /pin

Paramètre	Type	Requis	Description
`cid`	string	Oui	Identifiant de contenu IPFS (commence par `Qm` ou `bafy`).
`description`	string	Non	Description courte pour votre référence.
`metadata`	object	Non	Paires clé-valeur personnalisees a attacher au pin. Maximum 10 clés. Les clés doivent etre alphanumeriques ou underscore, de 1 à 64 caracteres. Les valeurs doivent etre des chaines, maximum 256 caracteres chacune. La taille totale des métadonnées ne doit pas depasser 4 Ko.

Exemple de requête

bash

curl -X POST https://api.ipfs.ninja/pin \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "cid": "QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F",
    "description": "NFT metadata",
    "metadata": {
      "collection": "my-nfts",
      "token_id": "42"
    }
  }'

Réponse `202 Accepted`

json

{
  "cid": "QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F",
  "status": "pinning",
  "description": "NFT metadata",
  "uris": {
    "ipfs": "ipfs://QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F",
    "url": "https://ipfs.ninja/ipfs/QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F"
  }
}

TIP

L'épinglage est asynchrone. La réponse est retournée immédiatement avec le statut pinning. Interrogez le endpoint de statut pour vérifier quand l'épinglage est termine.

Vérifier le Statut d'Épinglage

GET /pin/:cid

Paramètre	Type	Requis	Description
`cid`	string	Oui	Le CID que vous vérifiez.

Réponse `200 OK`

json

{
  "cid": "QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F",
  "status": "pinned",
  "sizeMB": 0.042,
  "fileName": "NFT metadata",
  "pinnedAt": 1711036800000,
  "uris": {
    "ipfs": "ipfs://QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F",
    "url": "https://ipfs.ninja/ipfs/QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F"
  }
}

Valeurs de statut

Statut	Signification
`pinning`	Le contenu est en cours de récupération depuis le réseau IPFS. Réinterrogez dans quelques secondes.
`pinned`	Le contenu est épinglé et disponible via votre compte et votre gateway.
`failed`	Le contenu n'a pas pu etre trouve sur le réseau IPFS. Le CID peut etre invalide ou le contenu n'est plus disponible.

Comment fonctionne l'épinglage

Vous soumettez un CID via POST /pin
Notre cluster IPFS cherche sur le réseau les nœuds qui ont le contenu
Le cluster téléchargé et épinglé le contenu localement
Une fois épinglé, le fichier apparait dans votre liste de fichiers et est accessible via le gateway
L'utilisation du stockage est enregistrée lorsque l'épinglage est termine

WARNING

Le temps d'épinglage depend de la taille du fichier et de la disponibilité sur le réseau. Les petits fichiers s'épinglent généralement en quelques secondes. Les fichiers volumineux ou le contenu rarement épinglé peuvent prendre des minutes.

Stockage

Le contenu épinglé compte dans la limite de stockage de votre plan. La taille du fichier est enregistrée lorsque l'épinglage est termine — vous pouvez initier un épinglage même si votre stockage est proche de la limite, mais les téléversements ulterieurs seront bloques si l'épinglage vous fait depasser la limite.

Épinglage ​

Épingler par CID ​

Exemple de requête ​

Réponse 202 Accepted ​

Vérifier le Statut d'Épinglage ​

Réponse 200 OK ​

Valeurs de statut ​

Comment fonctionne l'épinglage ​

Stockage ​