IPFS-SOUKO-API (0.2)

Download OpenAPI specification:Download

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme basic

File

Access to File

upload file on ipfs

ipfsノードへファイルをアップロードし、ファイルをピンニングする。

Authorizations:
Request Body schema: multipart/form-data
file
string <binary>

Responses

Response samples

Content type
application/json
No sample

upload file on Filecoin

Filecoinストレージマイナーへファイルを預ける

Authorizations:
Request Body schema: multipart/form-data
file
string <binary>

Responses

Response samples

Content type
application/json
No sample

download file from ipfs

自分が保存したファイルをIPFSネットワークからダウンロードする。

Authorizations:
Request Body schema: application/json
cid
string

Responses

Request samples

Content type
application/json
{
  • "cid": "QmVmEHjr6xtNxHDbJ7kXenYMH6C4ZGpjqNnMeAEk9dQcR3",
  • "fileName": "sample.png"
}

download file from filecoin

自分が保存したファイルをFilecoinネットワークからダウンロードする。

Authorizations:
Request Body schema: application/json
cid
string

Responses

Request samples

Content type
application/json
{
  • "cid": "QmVmEHjr6xtNxHDbJ7kXenYMH6C4ZGpjqNnMeAEk9dQcR3",
  • "fileName": "sample.png"
}

Response samples

Content type
application/json
{
  • "fileId": "string"
}

get upload status for filecoin

アップロードリクエストしたファイルのステータスを確認する

Authorizations:
Request Body schema: application/json
cid
string

Responses

Request samples

Content type
application/json
{
  • "cid": "QmVmEHjr6xtNxHDbJ7kXenYMH6C4ZGpjqNnMeAEk9dQcR3",
  • "fileName": "sample.png"
}

Response samples

Content type
application/json
{
  • "status": "uploading"
}

get download url for filecoin

自分が保存したファイルのダウンロードURLを取得する

Authorizations:
Request Body schema: application/json
cid
string

Responses

Request samples

Content type
application/json
{
  • "cid": "QmVmEHjr6xtNxHDbJ7kXenYMH6C4ZGpjqNnMeAEk9dQcR3",
  • "fileName": "sample.png"
}

Response samples

Content type
application/json
{
  • "status": "downloading",
  • "url": "string",
  • "url_expires_at": "2019-08-24T14:15:22Z"
}

remove file from ipfs

IPFSノードからファイルのピンニングを解除(unpin)する。

Authorizations:
Request Body schema: application/json
cid
string

Responses

Request samples

Content type
application/json
{
  • "cid": "QmVmEHjr6xtNxHDbJ7kXenYMH6C4ZGpjqNnMeAEk9dQcR3"
}

Response samples

Content type
application/json
{
  • "cid": "string"
}