基本機能 - 保有アイテムの取得

保有アイテムの取得機能を利用すると、ユーザーのDOSIアカウントにあるデジタルアイテムを確認できます。

接続情報

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

デジタルアイテム一覧の取得

指定されたcontract IDに属するデジタルアイテム一覧を取得します。ユーザーのDOSIアカウントにないデジタルアイテムもcontract IDが分かれば取得できます。

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

v1.0.0以前のバージョンで提供していたGET {DOSI SDK base URI}/v1/wallets/{walletAddress}/contracts/{contractId}/itemsはサポート終了となる予定ですので、代わりにこのエンドポイントを使用してください。

Request

Response

Path

Name	Type	Description
walletAddress	string	ユーザーのDOSIアカウントのウォレットアドレス
contractId	string	取得するデジタルアイテムのcontract ID。DOSI SDK利用申請後に取得したcontract IDまたはその他Finschiaにあるcontract IDを入力できます。
itemType	string	取得するデジタルアイテムタイプ。16進数の8桁のデジタルアイテムタイプまたは*を入力してください。 特定のアイテムタイプを入力すると、指定したアイテムタイプのデジタルアイテムのみ取得します。 *を入力すると、指定したcontract IDの下にあるすべてのアイテムタイプのデジタルアイテムを取得します。

Query

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

Body

None

Headers

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

Request examples

指定したアイテムタイプのデジタルアイテムの取得

すべてのデジタルアイテムの取得

curl --location --request GET 'https://sdk-api.dosi.world/v1/wallets/link1....xvb/item-contracts/abcdabcd/item-types/aaaaaaaa/items' \
  --header 'Authorization: Basic xxxxxxxx'

Name	Type	Description	Included
nextPageToken	string	次のページの開始を示すトークン。次のページがない場合は、nullになります。
items	array	取得したデジタルアイテムのリスト

Response status code

200 OK

Response headers

None

Related errors

None

Response examples

{
  "nextPageToken": "xxxxxxxx",
  "items":[
    {
      "tokenType":"abcdabcd",
      "tokenIndex":"00001010",
      "name":"token A",
      "meta":"{\"PropertyA\":\"ValueA\", \"PropertyB\":\"ValueB\"}"
    },
    {
      "tokenType":"abcdabcd",
      "tokenIndex":"00001011",
      "name":"token B",
      "meta":"{\"PropertyA\":\"ValueA\", \"PropertyB\":\"ValueB\"}"
    },
    ...
  ]
}

デジタルアイテム一覧の取得

このエンドポイントはサポート終了となる予定ですので、代わりにGET {DOSI SDK base URI}/v1/wallets/{walletAddress}/contracts/{contractId}/item-types/{itemType}/itemsを使用してください。

指定されたcontract IDに属するデジタルアイテム一覧を取得します。ユーザーのDOSIアカウントにないデジタルアイテムもcontract IDが分かれば取得できます。

GET {DOSI SDK base URI}/v1/wallets/{walletAddress}/contracts/{contractId}/items

Request

Response

Path

Name	Type	Description
walletAddress	string	ユーザーのDOSIアカウントのウォレットアドレス
contractId	string	取得するデジタルアイテムのcontract ID。DOSI SDK利用申請後に取得したcontract IDまたはその他Finschiaにあるcontract IDを入力できます。

Query

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

Body

None

Headers

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

Request examples

curl

curl --location --request GET 'https://sdk-api.dosi.world/v1/wallets/link1....xvb/contracts/abcdabcd/items' \
  --header 'Authorization: Basic xxxxxxxx'

Name	Type	Description	Included
nextPageToken	string	次のページの開始を示すトークン。次のページがない場合は、nullになります。
items	array	取得したデジタルアイテムのリスト

Response status code

200 OK

Response headers

None

Related errors

None

Response examples

{
  "nextPageToken": "xxxxxxxx",
  "items":[
    {
      "tokenType":"abcdabcd",
      "tokenIndex":"0000100e",
      "name":"token A",
      "meta":"{\"PropertyA\":\"ValueA\", \"PropertyB\":\"ValueB\"}"
    }, 
    {
      "tokenType":"abcdabcd",
      "tokenIndex":"0000100f",
      "name":"token B",
      "meta":"{\"PropertyA\":\"ValueA\", \"PropertyB\":\"ValueB\"}"
    },
    ...
  ]
}