Подписанные токены загрузки

Подписанные токены загрузки — это временные учётные данные для загрузки на стороне клиента. Они позволяют браузерам и мобильным приложениям загружать файлы напрямую в IPFS Ninja без раскрытия вашего API-ключа.

Типичный процесс: ваш сервер генерирует подписанный токен с помощью API-ключа, передаёт его клиенту, и клиент использует его для загрузки файлов. Токен автоматически истекает после указанного времени.

Сгенерировать подписанный токен

POST /upload/signed-url

Создайте новый подписанный токен загрузки.

Параметр	Тип	Обязательный	Описание
name	string	Нет	Метка для токена (например, "Mobile app uploads").
expiresIn	number	Да	Время жизни токена в секундах.

Пример запроса

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}'

Ответ 201 Created

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

WARNING

Полный токен возвращается только один раз при создании. Сохраните его в безопасном месте или сразу передайте клиенту.

Список подписанных токенов

GET /signed-tokens

Возвращает все подписанные токены для вашего аккаунта, включая статистику использования.

Пример запроса

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

Ответ 200 OK

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

Отозвать подписанный токен

DELETE /signed-tokens/:tokenId

Немедленно отзовите подписанный токен. Все последующие попытки загрузки с этим токеном будут отклонены.

Параметр	Тип	Обязательный	Описание
tokenId	string	Да	ID токена для отзыва (например, "tok_9876543210abcdef").

Пример запроса

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

Ответ 200 OK

{
  "message": "Token revoked"
}

Использование подписанного токена

Для загрузки с подписанным токеном передайте его через заголовок Authorization со схемой Signed:

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"}'

Тело запроса и формат ответа идентичны стандартной загрузке файла.

Отслеживание использования

Каждый раз при использовании подписанного токена увеличивается useCount и обновляется lastUsedAt. Вы можете отслеживать активность токенов через GET /signed-tokens.

Подписанные токены записываются с их префиксом в поле аналитики API_KEY_PREFIX. Это значит, что вы можете фильтровать аналитику по префиксу подписанного токена так же, как по префиксу API-ключа. Подробности см. в разделе Аналитика.

Пример: загрузка из браузера

Сгенерируйте токен на сервере и используйте его в клиентском 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);