Signierte Upload-Token

Signierte Upload-Token sind zeitlich begrenzte Anmeldeinformationen für clientseitige Uploads. Sie ermöglichen es Browsern und mobilen Apps, Dateien direkt auf IPFS Ninja hochzuladen, ohne Ihren API-Schlüssel preiszugeben.

Ein typischer Ablauf: Ihr Server generiert einen signierten Token mit Ihrem API-Schlüssel, übergibt ihn an den Client, und der Client verwendet ihn zum Hochladen von Dateien. Der Token läuft automatisch nach der angegebenen Dauer ab.

Signierten Token generieren

POST /upload/signed-url

Erstellen Sie einen neuen signierten Upload-Token.

Parameter	Typ	Erforderlich	Beschreibung
name	string	Nein	Bezeichnung für den Token (z. B. "Mobile app uploads").
expiresIn	number	Ja	Token-Lebensdauer in Sekunden.

Beispielanfrage

curl -X POST https://api.ipfs.ninja/upload/signed-url \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"name": "Mobile app", "expiresIn": 3600}'

Antwort 201 Created

{
  "token": "sup_a1b2c3d4e5f6789012345678abcdef01...",
  "tokenId": "tok_9876543210abcdef",
  "tokenPrefix": "sup_a1b2c3d4",
  "tokenName": "Mobile app",
  "expiresAt": 1711040400000
}

WARNING

Der vollständige Token wird nur einmal bei der Erstellung zurückgegeben. Speichern Sie ihn sicher oder übergeben Sie ihn direkt an Ihren Client.

Signierte Token auflisten

GET /signed-tokens

Gibt alle signierten Token für Ihr Konto zurück, einschließlich Nutzungsstatistiken.

Beispielanfrage

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

Antwort 200 OK

[
  {
    "tokenId": "tok_9876543210abcdef",
    "tokenPrefix": "sup_a1b2c3d4",
    "tokenName": "Mobile app",
    "expiresAt": 1711040400000,
    "useCount": 15,
    "lastUsedAt": 1711038600000,
    "createdAt": 1711036800000
  }
]

Signierten Token widerrufen

DELETE /signed-tokens/:tokenId

Widerrufen Sie einen signierten Token sofort. Alle nachfolgenden Upload-Versuche mit diesem Token werden abgelehnt.

Parameter	Typ	Erforderlich	Beschreibung
tokenId	string	Ja	Die Token-ID zum Widerrufen (z. B. "tok_9876543210abcdef").

Beispielanfrage

curl -X DELETE https://api.ipfs.ninja/signed-tokens/tok_9876543210abcdef \
  -H "X-Api-Key: bws_your_api_key_here"

Antwort 200 OK

{
  "message": "Token revoked"
}

Einen signierten Token verwenden

Um mit einem signierten Token hochzuladen, übergeben Sie ihn über den Authorization-Header mit dem Signed-Schema:

curl -X POST https://api.ipfs.ninja/upload/new \
  -H "Authorization: Signed sup_a1b2c3d4e5f6789012345678abcdef01..." \
  -H "Content-Type: application/json" \
  -d '{"content": {"name": "example"}, "description": "Client upload"}'

Der Anfragekörper und das Antwortformat sind identisch mit einem normalen Datei-Upload.

Nutzungsverfolgung

Jedes Mal, wenn ein signierter Token verwendet wird, wird der useCount erhöht und lastUsedAt aktualisiert. Sie können die Token-Aktivität über GET /signed-tokens überwachen.

Signierte Token werden mit ihrem Präfix im Analytics-Feld API_KEY_PREFIX erfasst. Das bedeutet, Sie können Analysen nach signiertem Token-Präfix filtern, genauso wie nach API-Schlüssel-Präfix. Siehe Analysen für Details.

Beispiel: Browser-Upload

Generieren Sie einen Token auf Ihrem Server und verwenden Sie ihn im clientseitigen JavaScript:

// Server-side: generate a token valid for 1 hour
const res = await fetch("https://api.ipfs.ninja/upload/signed-url", {
  method: "POST",
  headers: {
    "X-Api-Key": "bws_your_server_key",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ name: "Web form", expiresIn: 3600 })
});
const { token } = await res.json();
// Pass `token` to the client

// Client-side: upload a file using the signed token
const file = document.getElementById("fileInput").files[0];
const reader = new FileReader();
reader.onload = async () => {
  const base64 = reader.result.split(",")[1];
  const uploadRes = await fetch("https://api.ipfs.ninja/upload/new", {
    method: "POST",
    headers: {
      "Authorization": `Signed ${token}`,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      content: base64,
      description: "User upload"
    })
  });
  const data = await uploadRes.json();
  console.log("Uploaded:", data.cid);
};
reader.readAsDataURL(file);