デジタルアイテム機能

開発環境	DOSI SDK base URI
プロダクション環境	https://sdk-api.dosi.world

新しいアイテムタイプを作成し、そのタイプのデジタルアイテムをDOSIブランドストアで取引できるように登録します。

POST {DOSI SDK base URI}/v1/item/contracts/{contractId}/issue

Request

Response

Path

Name	Type	Description
`contractId`	string	アイテムタイプを作成するサービスのcontract ID。DOSI SDK利用申請後に取得できます。リクエストヘッダーのAuthorizationで指定されたDOSIチャネルにリンクされたcontract IDを入力する必要があります。

Query

None

Body

Name	Type	Description
`txId`	string	APIリクエストを追跡するために使用する識別子。RFC 9562で定義されたUUID文字列（大文字小文字を区別しない）を使用してください。識別子は、DOSI SDKサーバーにリクエストを送信した後、その処理結果をトランザクションで確認する際に使用します。識別子を指定しない場合、DOSI SDKサーバーが識別子を生成して応答として返します。ネットワーク障害などの問題でサーバーの応答を受け取れない状況でも処理結果を確認したい場合は、この値を指定してください。
`name`	string	デジタルアイテム（トークン）タイプの名前。3～20文字の英数字のみを入力できます（空白、特殊文字、日本語、韓国語、中国語、タイ語などは使用不可）。
`meta`	string	Finschiaに記録するメタデータ。キーと値のペアで構成されたオブジェクトを文字列で作成したもので、最大1,000文字まで入力できます。詳しくは、メタデータの入力ガイドを参照してください。
`partnerId`	number	DOSI Bizオンボーディングの際に発行されるパートナーID
`category`	string	デジタルアイテムのカテゴリー。以下のカテゴリーのいずれかにしてください。 "Art" "Character" "Game" "Music" "Sports" "Celebrity" "Metaverse" "Generative" "Avatar" "App Membership" "Voucher"
`pfp`	boolean	DOSIユーザープロフィールとして設定可能かどうか `true`：作成したデジタルアイテムをユーザープロフィールとして設定可能 `false`：作成したデジタルアイテムをユーザープロフィールとして設定不可
`description`	string	DOSIブランドストアのアイテムページに表示されるデジタルアイテムの説明。最大3,000文字まで入力できます。英語、日本語、韓国語、中国語（繁体字）、タイ語、数字、空白、一部の特殊文字（! , / @）を使用できます。
`resaleAvailable`	boolean	DOSIブランドストアでC2C（customers to customers）販売可能かどうか. 入力されていない場合は `true` とみなします。 `true`：C2C販売登録可能（デフォルト値） `false`：C2C販売登録不可

Headers

Authorization: Basic <「DOSIチャネルID：シークレット」をBase64でエンコードした値>
Request-Id: 重複を確認するためにランダムに作成されたUUID
Content-Type: application/json

Request-Idが重複すると、以下のエラーが返されます。
{ 
   "responseCode": "BAD_REQUEST",
   "errorMessage": "Duplicated request has been detected"
}

Request examples

curl

curl --request POST 'https://sdk-api.dosi.world/v1/item/contracts/xx...ss/issue' \
  --header 'Authorization: Basic xxxxxxxx' \
  --header 'Request-Id: 550e8400-e29b-41d4-a716-446655440000' \
  --header 'Content-Type: application/json' \
  --data-raw '{
      "name":"itemTypeName",
      "meta":"{\"Property A\":\"Value A\"}",
      "partnerId": 100012,
      "category": "Game",
      "pfp": true,
      "description": "Awesome description of your digital item",
      "resaleAvailable": true
  }'

Name	Type	Description
`txId`	string	リクエストを処理するトランザクションのID。リクエストに`txId`がある場合、その値を返します。

発行したデジタルアイテムタイプの名前とメタデータを変更します。

PUT {DOSI SDK base URI}/v1/item/contracts/{contractId}/item-types/{itemType}

Request

Response

Path

Name	Type	Description
`contractId`	string	サービスのcontract ID。DOSI SDK利用申請後に取得できます。リクエストヘッダーのAuthorizationで指定されたDOSIチャネルにリンクされたcontract IDを入力する必要があります。
`itemType`	string	デジタルアイテムのアイテムタイプ（16進数の8桁のコード）

Query

None

Body

Name

Type

Description

Required

txId

string

APIリクエストを追跡するために使用する識別子。RFC 9562で定義されたUUID文字列（大文字小文字を区別しない）を使用してください。

識別子は、DOSI SDKサーバーにリクエストを送信した後、その処理結果をトランザクションで確認する際に使用します。識別子を指定しない場合、DOSI SDKサーバーが識別子を生成して応答として返します。

ネットワーク障害などの問題でサーバーの応答を受け取れない状況でも処理結果を確認したい場合は、この値を指定してください。

name

string

変更する名前。3～20文字の英語、日本語、韓国語、中国語（繁体字）、タイ語、数字、空白、および一部の特殊文字（!、,、/、@）を使用できます。

変更したくない場合はnullを入力してください。

nameとmetaの両方がnullの場合、BAD_REQUESTエラーが返されます。

meta

string

変更するメタデータ（プロパティ）。シーリングの際に設定したデジタルアイテムのメタデータを変更できます。詳しくは、メタデータの入力ガイドを参照してください。

変更したくない場合はnullを入力してください。

nameとmetaの両方がnullの場合、BAD_REQUESTエラーが返されます。

Headers

Authorization: Basic <「DOSIチャネルID：シークレット」をBase64でエンコードした値>
Request-Id: 重複を確認するためにランダムに作成されたUUID
Content-Type: application/json

Request-Idが重複すると、以下のエラーが返されます。
{ 
   "responseCode": "BAD_REQUEST",
   "errorMessage": "Duplicated request has been detected"
}

Request examples

curl

curl --request PUT 'https://sdk-api.dosi.world/v1/item/contracts/aaaaaaaa/item-types/bbbbbbbb' \
--header 'Authorization: Basic xxxxxxxx' \
--header 'Request-Id: 00000000-0000-0000-0000-000000000000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name":"newItemTypeName",
    "meta":"{\"Property A\":\"Value A\"}"
}'

Name	Type	Description
`txId`	string	リクエストを処理するトランザクションのID。リクエストに`txId`がある場合、その値を返します。

作成したアイテムタイプのメディア（画像、動画）をアップロードします。

POST {DOSI SDK base URI}/v1/item/contracts/{contractId}/media/token-type

アイテムタイプを作成するエンドポイントを利用して作成したアイテムタイプではない場合、メディアをアップロードできません。

メディアのアップロードガイドでアップロードできるファイルタイプやサイズを必ず確認してください。

HTTPクライアントライブラリを使用してメディアをアップロードする場合は、必ずmultipart/form-dataで送信してください。ライブラリによって詳細な使い方は異なる場合がありますが、通常、リクエストヘッダーのContent-Typeを"multipart/form-data"に指定する必要があります。

Request

Response

Path

Name	Type	Description
`contractId`	string	DOSI SDK利用申請後に取得したcontract ID。リクエストヘッダーのAuthorizationで指定されたDOSIチャネルにリンクされたcontract IDを入力する必要があります。

Query

None

Body

Name	Type	Description	Required
`media`	file	アップロードするメディアファイル（画像／動画）
`tokenType`	string	アイテムタイプ。8桁の16進数で、アイテムタイプを作成する際に分かります。

Headers

Authorization: Basic <「DOSIチャネルID：シークレット」をBase64でエンコードした値>
Content-Type: multipart/form-data

Request examples

curl

curl --request POST 'https://sdk-api.dosi.world/v1/item/contracts/xx...ss/media/token-type' \
  --header 'Authorization: Basic xxxxxxxx' \
  --header 'Content-Type: multipart/form-data' \
  --form "media=@path/name.png" \
  --form "tokenType=00000001"

パートナー企業のcontract IDの下にあるすべてのアイテムタイプを取得します。

GET {DOSI SDK base URI}/v1/item/contracts/{contractId}/item-types

DOSI SDKのアイテムタイプを作成するエンドポイントを使用せずに作成したアイテムタイプも取得できます。

Request

Response

Path

Name	Type	Description
`contractId`	string	DOSI SDK利用申請後に取得したcontract ID。リクエストヘッダーのAuthorizationで指定されたDOSIチャネルにリンクされたcontract IDを入力する必要があります。

Query

Name	Type	Description	Required
`pageSize`	number	1ページに含まれるアイテムタイプ数デフォルト値：10 最小値：1 最大値：100
`pageToken`	string	ページの開始を示すトークン（前のページを取得したときの応答の`nextPageToken`）。指定されていない場合は、最初のページを取得します。

Name

Type

Description

Required

pageSize

number

1ページに含まれるアイテムタイプ数

デフォルト値：10
最小値：1
最大値：100

pageToken

string

ページの開始を示すトークン（前のページを取得したときの応答のnextPageToken）。指定されていない場合は、最初のページを取得します。

Body

None

Headers

Authorization: Basic <「DOSIチャネルID：シークレット」をBase64でエンコードした値>
Content-Type: application/json

Request examples

curl

curl --location --request GET 'https://sdk-api.dosi.world/v1/item/contracts/xx...ss/item-types?pageSize=30&pageToken=zz...uu'
  --header 'Authorization: Basic xxxxxxxx' \
  --header 'Content-Type: application/json'

Name	Type	Description	Included
`itemTypes`	array	取得したアイテムタイプのリスト。取得する対象がない場合、空の配列を返します。
`nextPageToken`	string	次のページの開始を示すトークン。次のページがない場合は、nullになります。

パートナー企業のcontract IDの下にある特定のアイテムタイプを取得します。

GET {DOSI SDK base URI}/v1/item/contracts/{contractId}/item-types/{itemType}

DOSI SDKのアイテムタイプを作成するエンドポイントを使用せずに作成したアイテムタイプも取得できます。

Request

Response

Path

Name	Type	Description
`contractId`	string	DOSI SDK利用申請後に取得したcontract ID。リクエストヘッダーのAuthorizationで指定されたDOSIチャネルにリンクされたcontract IDを入力する必要があります。
`itemType`	string	取得するアイテムタイプの識別子（16進数の8桁のコード）

Query

None

Body

None

Headers

Authorization: Basic <「DOSIチャネルID：シークレット」をBase64でエンコードした値>
Content-Type: application/json

Request examples

curl

curl --location --request GET 'https://sdk-api.dosi.world/v1/item/contracts/xx...ss/item-types/yy...tt'
  --header 'Authorization: Basic xxxxxxxx' \
  --header 'Content-Type: application/json'

Name	Type	Description
`contractId`	string	アイテムタイプが属するcontract ID
`itemType`	string	アイテムタイプの識別子（16進数の8桁のコード）
`name`	string	アイテムタイプの名前
`meta`	string	アイテムタイプのメタデータ

パートナー企業の商品をDOSIブランドストアで販売するデジタルアイテムに変換します。オフチェーン商品をオンチェーン化できます。

POST {DOSI SDK base URI}/v1/item/contracts/{contractId}/sealing

プロキシ（proxy）を承認したユーザーアカウントでのみ使用できます。

Request

Response

Path

Name	Type	Description
`contractId`	string	DOSI SDK利用申請後に取得したcontract ID。リクエストヘッダーのAuthorizationで指定されたDOSIチャネルにリンクされたcontract IDを入力する必要があります。

Query

None

Body

Name	Type	Description
`txId`	string	APIリクエストを追跡するために使用する識別子。RFC 9562で定義されたUUID文字列（大文字小文字を区別しない）を使用してください。識別子は、DOSI SDKサーバーにリクエストを送信した後、その処理結果をトランザクションで確認する際に使用します。識別子を指定しない場合、DOSI SDKサーバーが識別子を生成して応答として返します。ネットワーク障害などの問題でサーバーの応答を受け取れない状況でも処理結果を確認したい場合は、この値を指定してください。
`tokenType`	string	デジタルアイテムのアイテムタイプ。8桁の16進数で、アイテムタイプを作成する際に分かります。
`toAddress`	string	シーリングしたデジタルアイテムを受け取るユーザーのDOSIアカウントのウォレットアドレスアドレス
`name`	string	デジタルアイテムの名前。3～20文字の英語、日本語、韓国語、中国語（繁体字）、タイ語、数字、空白、および一部の特殊文字（`!`、`,`、`/`、`@`）を使用できます。
`meta`	string	Finschiaに記録するメタデータ。キーと値のペアで構成されたオブジェクトを文字列で作成したもので、最大1,000文字まで入力できます。詳しくは、メタデータの入力ガイドを参照してください。
`option`	object	シーリング時に処理する追加作業。追加作業がない場合は、この項目を削除するか、またはnullを入力してください。

Headers

Authorization: Basic <「DOSIチャネルID：シークレット」をBase64でエンコードした値>
Request-Id: 重複を確認するためにランダムに作成されたUUID
Content-Type: application/json

Request-Idが重複すると、以下のエラーが返されます。
{ 
   "responseCode": "BAD_REQUEST",
   "errorMessage": "Duplicated request has been detected"
}

Request examples

curl

curl --request POST 'https://sdk-api.dosi.world/v1/item/contracts/xx...ss/sealing' \
  --header 'Authorization: Basic xxxxxxxx' \
  --header 'Request-Id: 550e8400-e29b-41d4-a716-446655440000' \
  --header 'Content-Type: application/json' \
  --data-raw '{
      "tokenType": "0000001F",
      "toAddress": "link1xxxxxxxxxxzzzzzzzzzzxxxxxxxxxxzzzzzzzz",
      "name":"item1",
      "meta":"{\"Property A\":\"Value A\"}",
      "option": {
          "mediaUpload": {
              "sourceUrl": "https://example.com/example.png"
          }
      }
  }'

Name	Type	Description
`txId`	string	リクエストを処理するトランザクションのID。リクエストに`txId`がある場合、その値を返します。

パートナー企業の複数の商品をまとめて、DOSIブランドストアで販売するデジタルアイテムに変換します。オフチェーン商品をオンチェーン化できます。

POST {DOSI SDK base URI}/v1/item/contracts/{contractId}/batch-sealing

プロキシ(proxy)を承認したユーザーアカウントでのみ使用できます。

Request

Response

Path

Name	Type	Description	Required
`contractId`	string	DOSI SDK利用申請後に取得したcontract ID。リクエストヘッダーのAuthorizationで指定されたDOSIチャネルにリンクされたcontract IDを入力する必要があります。

Query

None

Body

Name

Type

Description

Required

txId

string

APIリクエストを追跡するために使用する識別子。RFC 9562で定義されたUUID文字列（大文字小文字を区別しない）を使用してください。

識別子は、DOSI SDKサーバーにリクエストを送信した後、その処理結果をトランザクションで確認する際に使用します。識別子を指定しない場合、DOSI SDKサーバーが識別子を生成して応答として返します。

ネットワーク障害などの問題でサーバーの応答を受け取れない状況でも処理結果を確認したい場合は、この値を指定してください。

sealingList

array

シーリングする対象のリスト。対象の数は最小1個、最大100個です。

Headers

Authorization: Basic <「DOSIチャネルID：シークレット」をBase64でエンコードした値>
Request-Id: 重複を確認するためにランダムに作成されたUUID
Content-Type: application/json

Request-Idが重複すると、以下のエラーが返されます。
{ 
   "responseCode": "BAD_REQUEST",
   "errorMessage": "Duplicated request has been detected"
}

Request examples

curl

curl --request POST 'https://sdk-api.dosi.world/v1/item/contracts/aaaaaaaa/batch-sealing' \
--header 'Authorization: Basic xxxxxxxx' \
--header 'Request-Id: 00000000-0000-0000-0000-000000000000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "txId": "00000000-0000-0000-0000-000000000001",
    "sealingList": [
        {
            "tokenType": "0000001f",
            "toAddress": "link1xxxxxxxxxxzzzzzzzzzzxxxxxxxxxxzzzzzzzz",
            "name":"item1",
            "meta":"{\"Property A\":\"Value A\"}"
        }
    ]
}'

Name	Type	Description
`txId`	string	リクエストを処理するトランザクションのID。リクエストに`txId`がある場合、その値を返します。

デジタルアイテムのメディア（画像、動画）をアップロードします。デジタルアイテムはDOSI SDKを用いて作成したアイテムタイプにシーリングしたものである必要があります。

POST {DOSI SDK base URI}/v1/item/contracts/{contractId}/media/item-token

アイテムタイプを作成するエンドポイントを利用して作成したアイテムタイプのデジタルアイテムではない場合、メディアをアップロードできません。

メディアのアップロードガイドでアップロードできるファイルタイプやサイズを必ず確認してください。

HTTPクライアントライブラリを使用してメディアをアップロードする場合は、必ずmultipart/form-dataで送信してください。ライブラリによって詳細な使い方は異なる場合がありますが、通常、リクエストヘッダーのContent-Typeを"multipart/form-data"に指定する必要があります。

Request

Response

Path

Name	Type	Description
`contractId`	string	DOSI SDK利用申請後に取得したcontract ID。リクエストヘッダーのAuthorizationで指定されたDOSIチャネルにリンクされたcontract IDを入力する必要があります。

Query

None

Body

Name	Type	Description
`media`	file	アップロードするメディアファイル（画像／動画）
`tokenType`	string	デジタルアイテムのアイテムタイプ。8桁の16進数で、アイテムタイプを作成する際に分かります。
`tokenIndex`	string	デジタルアイテムのアイテムインデックス。8桁の16進数

Headers

Authorization: Basic <「DOSIチャネルID：シークレット」をBase64でエンコードした値>
Content-Type: multipart/form-data

Request examples

curl

curl --request POST 'https://sdk-api.dosi.world/v1/item/contracts/xx...ss/media/item-token' \
  --header 'Authorization: Basic xxxxxxxx' \
  --header 'Content-Type: multipart/form-data' \
  --form "media=@path/name.png" \
  --form "tokenType=00000001" \
  --form "tokenIndex=00000002"

デジタルアイテムに登録したメディア（画像、動画）を置き換えます。デジタルアイテムをシーリングする前または販売する前に限って、作成したアイテムタイプ内のデジタルアイテムのメディアを置き換えることができます。

PUT {DOSI SDK base URI}/v1/item/contracts/{contractId}/media/item-token

アイテムタイプを作成するエンドポイントを利用して作成したデジタルアイテムのメディアではない場合、置き換えることはできません。

シーリングまたは販売され、ユーザーウォレットに保管されているデジタルアイテムのメディアの場合、置き換えることはできません。

メディアのアップロードガイドでアップロードできるファイルタイプやサイズを必ず確認してください。

HTTPクライアントライブラリを使用してメディアをアップロードする場合は、必ずmultipart/form-dataで送信してください。ライブラリによって詳細な使い方は異なる場合がありますが、通常、リクエストヘッダーのContent-Typeを"multipart/form-data"に指定する必要があります。

Request

Response

Path

Name	Type	Description
`contractId`	string	DOSI SDK利用申請後に取得したcontract ID。リクエストヘッダーのAuthorizationで指定されたDOSIチャネルにリンクされたcontract IDを入力する必要があります。

Query

None

Body

Name	Type	Description
`media`	file	置き換えるメディアファイル（画像／動画）
`tokenType`	string	デジタルアイテムのアイテムタイプ。8桁の16進数で、アイテムタイプを作成する際に分かります。
`tokenIndex`	string	デジタルアイテムのアイテムインデックス。8桁の16進数

Headers

Authorization: Basic <「DOSIチャネルID：シークレット」をBase64でエンコードした値>
Content-Type: multipart/form-data

Request examples

curl

curl --request PUT 'https://sdk-api.dosi.world/v1/item/contracts/xx...ss/media/item-token' \
  --header 'Authorization: Basic xxxxxxxx' \
  --header 'Content-Type: multipart/form-data' \
  --form "media=@path/name.png" \
  --form "tokenType=00000001" \
  --form "tokenIndex=00000002"

シーリングしたアイテムをオフチェーンアイテムに戻します。

PUT {DOSI SDK base URI}/v1/item/contracts/{contractId}/unsealing

プロキシ（proxy）を承認したユーザーアカウントでのみ使用できます。

Request

Response

Path

Name	Type	Description
`contractId`	string	DOSI SDK利用申請後に取得したcontract ID。リクエストヘッダーのAuthorizationで指定されたDOSIチャネルにリンクされたcontract IDを入力する必要があります。

Query

None

Body

Name	Type	Description
`txId`	string	APIリクエストを追跡するために使用する識別子。RFC 9562で定義されたUUID文字列（大文字小文字を区別しない）を使用してください。識別子は、DOSI SDKサーバーにリクエストを送信した後、その処理結果をトランザクションで確認する際に使用します。識別子を指定しない場合、DOSI SDKサーバーが識別子を生成して応答として返します。ネットワーク障害などの問題でサーバーの応答を受け取れない状況でも処理結果を確認したい場合は、この値を指定してください。
`tokenType`	string	デジタルアイテムのアイテムタイプ。8桁の16進数で、アイテムタイプを作成する際に分かります。
`tokenIndex`	string	デジタルアイテムインデックス。8桁の16進数
`fromAddress`	string	アンシーリングするアイテムを保持しているユーザーのDOSIアカウントのウォレットアドレス

Headers

Authorization: Basic <「DOSIチャネルID：シークレット」をBase64でエンコードした値>
Content-Type: application/json

Request examples

curl

curl --request PUT 'https://sdk-api.dosi.world/v1/item/contracts/xx...ss/unsealing' \
  --header 'Authorization: Basic xxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
      "tokenType": "00000001", 
      "tokenIndex": "0000001F",
      "fromAddress": "link1xxxxxxxxxxzzzzzzzzzzxxxxxxxxxxzzzzzzzz"
  }'

Name	Type	Description
`txId`	string	リクエストを処理するトランザクションのID。リクエストに`txId`がある場合、その値を返します。

あるユーザーのウォレットにある複数のデジタルアイテムを、まとめてオフチェーンアイテムに戻します。

PUT {DOSI SDK base URI}/v1/item/contracts/{contractId}/batch-unsealing

プロキシ(proxy)を承認したユーザーアカウントでのみ使用できます。

Request

Response

Path

Name	Type	Description
`contractId`	string	DOSI SDK利用申請後に取得したcontract ID。リクエストヘッダーのAuthorizationで指定されたDOSIチャネルにリンクされたcontract IDを入力する必要があります。

Query

None

Body

Name

Type

Description

Required

txId

string

APIリクエストを追跡するために使用する識別子。RFC 9562で定義されたUUID文字列（大文字小文字を区別しない）を使用してください。

識別子は、DOSI SDKサーバーにリクエストを送信した後、その処理結果をトランザクションで確認する際に使用します。識別子を指定しない場合、DOSI SDKサーバーが識別子を生成して応答として返します。

ネットワーク障害などの問題でサーバーの応答を受け取れない状況でも処理結果を確認したい場合は、この値を指定してください。

tokenList

array

アンシーリングするデジタルアイテムのリスト

fromAddress

string

アンシーリングするアイテムを保持しているユーザーのDOSIアカウントのウォレットアドレス

Headers

Authorization: Basic <「DOSIチャネルID：シークレット」をBase64でエンコードした値>
Content-Type: application/json

Request examples

curl

curl --request PUT 'https://sdk-api.dosi.world/v1/item/contracts/xx...ss/batch-unsealing' \
  --header 'Authorization: Basic xxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
      "tokenList": [
          {
              "tokenType": "00000001",  
              "tokenIndex": "0000001F"
          },
          {
              "tokenType": "00000001",  
              "tokenIndex": "0000001A"
          },
      ], 
      "fromAddress": "link1xxxxxxxxxxzzzzzzzzzzxxxxxxxxxxzzzzzzzz"
  }'

Name	Type	Description
`txId`	string	リクエストを処理するトランザクションのID。リクエストに`txId`がある場合、その値を返します。

一度シーリング（sealing）した後、アンシーリング（unsealing）した商品を再度シーリングします。再シーリングしてもFinschiaチェーン上にあるデジタルアイテムの発行総量は変わりません。

DOSIブランドストアで販売する前にこのエンドポイントを呼び出してnameとmetaを入力すると、デジタルアイテムの既存の名前とプロパティを変更できます。

アイテムタイプを作成するエンドポイントで作成していないデジタルアイテムの名前とプロパティは変更できません。

POST {DOSI SDK base URI}/v1/item/contracts/{contractId}/resealing

プロキシ（proxy）を承認したユーザーアカウントでのみ使用できます。

Request

Response

Path

Name	Type	Description
`contractId`	string	DOSI SDK利用申請後に取得したcontract ID。リクエストヘッダーのAuthorizationで指定されたDOSIチャネルにリンクされたcontract IDを入力する必要があります。

Query

None

Body

Name	Type	Description
`txId`	string	APIリクエストを追跡するために使用する識別子。RFC 9562で定義されたUUID文字列（大文字小文字を区別しない）を使用してください。識別子は、DOSI SDKサーバーにリクエストを送信した後、その処理結果をトランザクションで確認する際に使用します。識別子を指定しない場合、DOSI SDKサーバーが識別子を生成して応答として返します。ネットワーク障害などの問題でサーバーの応答を受け取れない状況でも処理結果を確認したい場合は、この値を指定してください。
`tokenType`	string	デジタルアイテムのアイテムタイプ。8桁の16進数で、アイテムタイプを作成する際に分かります。
`tokenIndex`	string	デジタルアイテムのアイテムインデックス。8桁の16進数
`toAddress`	string	再シーリングしたデジタルアイテムを受け取るユーザーのDOSIアカウントのウォレットアドレス
`name`	string	変更する名前。3～20文字の英語、日本語、韓国語、中国語（繁体字）、タイ語、数字、空白、および一部の特殊文字（!、,、/、@）を使用できます。 `name`と`meta`はペアなので、両方とも入力するか、または両方とも入力しないでください。どちらか一方だけを入力すると、BAD_REQUESTエラーが返されます。
`meta`	string	変更するメタデータ（プロパティ）。シーリングの際に設定したデジタルアイテムのメタデータを変更できます。詳しくは、メタデータの入力ガイドを参照してください。 `name`と`meta`はペアなので、両方とも入力するか、または両方とも入力しないでください。どちらか一方だけを入力すると、BAD_REQUESTエラーが返されます。

Headers

Authorization: Basic <「DOSIチャネルID：シークレット」をBase64でエンコードした値>
Content-Type: application/json

Request examples

nameとmetaを変更する場合

nameとmetaを変更しない場合

curl --request PUT 'https://sdk-api.dosi.world/v1/item/contracts/xx...ss/unsealing' \
  --header 'Authorization: Basic xxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
      "tokenType": "00000001", 
      "tokenIndex": "0000001F",
      "toAddress": "link1xxxxxxxxxxzzzzzzzzzzxxxxxxxxxxzzzzzzzz",
      "name":"item1",
      "meta":"{\"Property A\":\"Value A\"}"
  }'

Name	Type	Description
`txId`	string	リクエストを処理するトランザクションのID。リクエストに`txId`がある場合、その値を返します。

トランザクションIDを利用してトランザクションのステータスを取得します。

GET {DOSI SDK base URI}/v1/item/transactions/{txId}

Request

Response

Path

Name	Type	Description
`txId`	string	取得するトランザクションのID。シーリング、アンシーリング、再シーリングなど、トランザクションを引き起こすリクエストを送信した後、応答として受信した値を入力します。

Query

None

Body

None

Headers

Authorization: Basic <「DOSIチャネルID：シークレット」をBase64でエンコードした値>
Content-Type: application/json

Request examples

curl

curl --location --request GET 'https://sdk-api.dosi.world/v1/item/transactions/{txId}' \
  --header 'Authorization: Basic xxxxxxxx' \
  --header 'Content-Type: application/json'

デジタルアイテム機能

接続情報

アイテムタイプの作成

アイテムタイプの変更

アイテムタイプのメディアのアップロード

すべてのアイテムタイプの取得

個々のアイテムタイプの取得

シーリング（Sealing）

バッチシーリング（Batch sealing）

デジタルアイテムのメディアのアップロード

デジタルアイテムのメディアの置き換え

アンシーリング（Unsealing）

バッチアンシーリング（Batch unsealing）

再シーリング（Resealing）

トランザクションの取得

Name	Type	Description
`type`	string	処理タイプ。以下のいずれかです。 "SEALING" "UNSEALING" "RESEALING" "NONE" "ISSUE" "PROXY_COMMIT"
`status`	string	処理ステータス。以下のいずれかです。 "ACCEPTED" "PENDING" "SUCCESS" "FAILURE" Sealing時に追加作業を入力した場合、その作業結果に関係なく、トランザクション処理が完了した後にSUCCESSまたはFAILUREを返します。追加作業の処理結果は応答の`option`で確認できます。
`txHash`	string	トランザクションハッシュ
`items`	array	トランザクションに含まれるデジタルアイテムリスト
`option`	object	処理する追加作業。追加作業がない場合はnullです。