https://www.safecreative.org/mw/index.php?action=history&feed=atom&title=Nft.registerNft.register - Revision history2026-04-06T00:27:48ZRevision history for this page on the wikiMediaWiki 1.43.1https://www.safecreative.org/mw/index.php?title=Nft.register&diff=821&oldid=prevAdminwiki: Created page with "Registers an external NFT associated to a work. A NFT info page will be generated in IPFS. This call requires a nonce key = Info = * '''Component name:''' nft.register..."2022-04-20T11:16:36Z<p>Created page with "Registers an external NFT associated to a work. A NFT info page will be generated in IPFS. This call requires a <a href="/api-doc/Nonce_key" title="Nonce key">nonce key</a> = Info = * '''Component name:''' nft.register..."</p>
<p><b>New page</b></p><div>Registers an external NFT associated to a work.<br />
<br />
A NFT info page will be generated in IPFS.<br />
<br />
This call requires a [[nonce key]]<br />
<br />
= Info =<br />
* '''Component name:''' nft.register<br />
* '''Signature:''' Requires signature using the authkey's private key<br />
* '''Timestamp:''' Requires [[ztime parameter]]<br />
* '''Nonce key:''' Requires a [[nonce key]]<br />
* '''Authorization level''': ADD<br />
* '''API trust level''': Partner<br />
<br />
= Parameters = <br />
* '''authkey*:''' Authorization key<br />
* '''ztime*:''' Z-Timestamp<br />
* '''noncekey*''': [[nonce key]]<br />
* '''workcode*''': Code of the work associated to the NFT. The work must be in REGISTERED state.<br />
* '''tokentype*:''' NFT type (ERC720 or ERC1155)<br />
* '''network*:''' Blockchain network (ETHEREUM, POLYGON,...)<br />
* '''smartcontract*:''' Address of smart contract (0x...)<br />
* '''tokenid*:''' NFT token ID<br />
* '''wallet*:''' Minter wallet address (0x...)<br />
* '''language*:''' Language for info page<br />
** ''en'': English<br />
** ''es'': Spanish<br />
* '''supply:''' NFT issues supply (for ERC1155) defaults to 1<br />
* '''exclusive:''' 1 to mark this NFT as exclusive (no other NFT exists for the work)<br />
* '''licensetype:''' Type of license granted by the NFT<br />
** ''PRIVATE'': Non-commercial end user <br />
** ''PROFESSIONAL'': Professional end user<br />
** ''DISTRIBUTION'': Distributor<br />
** ''CUSTOM'': Custom license, must be accompanied by the ''customlicense'' parameter<br />
* '''customlicense:''' Full license text explaining the rights granted by the NFT over the work (for CUSTOM licensetype)<br />
* '''licenserights:''' Text explaining the rights or kind of usage granted by the NFT over the work<br />
* '''licenselimitations:''' Text explaining any limitations on the usage described by ''licenserights''<br />
** Eg. geographic limits, kind of allowed projects,...<br />
* '''numberofuses:''' Number of uses or copies of the work allowed by this NFT<br />
** For ''licenserights'' allowing to create physical copies of the work, this field will specify how many copies are allowed<br />
* '''validuntil:''' Date limit for the rights granted by this NFT<br />
** Date format: ''yyyy-mm-ddThh:mm:ssZ''<br />
* '''allowresale:''' 1 if this NFT can be resold by its owner, 0 otherwise (defaults to 1)<br />
* '''royaltywallet''N'':''' (multivalue) wallet address that receives royalties on sales of the NFT<br />
* '''royaltypercent''N'':''' (multivalue, integer) % of the sale price received as royalties by the corresponding wallet<br />
** There must be the same number of ''royaltywallet'' and ''royaltypercent'' parameters<br />
* '''imageurl*''': HTTP or IPFS url of the NFT image<br />
* '''audiourl''': HTTP or IPFS url of the NFT audio file<br />
* '''videourl''': HTTP or IPFS url of the NFT video file<br />
<br />
= Returns =<br />
<br />
* '''nftregistry'''<br />
** '''id''': NFT registration internal ID<br />
** '''workCode''': Code of the registered work<br />
** '''licenseIpfsUrl''': IPFS url of the generated NFT info page<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<br />
<nowiki>https://api.safecreative.org/v2/</nowiki><br />
?'''component'''=nft.register<br />
&'''authkey'''=28c2cvwp1iljjgoai4u0v57mk<br />
&'''noncekey'''=1jnpyhwkmowihrlwix5qls204<br />
&'''workcode'''=2204200018768<br />
&'''network'''=ETHEREUM<br />
&'''smartcontract'''=0x0000000000<br />
&'''tokenid'''=7890<br />
&'''tokentype'''=ERC1155<br />
&'''wallet'''=0xc9AEBf2e4c05e2674cc59E20C9E526a36c785252<br />
&'''imageurl'''=ipfs%3A%2F%2Fipfs%2FQmZP3nkJiAFyLAkRgZjcqjJWVg53ZyqfueftUzmB8g7Mio<br />
&'''audiourl'''=ipfs%3A%2F%2Fipfs%2FQmWqmqEPjCewqLzDcSmmuN5pKV1MsWqN1CvsJWqb46Aka1%2Fanimation.mp3<br />
&'''language'''=en<br />
&'''licenselimitations'''=Sport+transmissions+and+private+events<br />
&'''licenserights'''=Public+reproduction<br />
&'''licensetype'''=PROFESSIONAL<br />
&'''ztime'''=1650445718415<br />
&'''signature'''=b4e3ddacc5776b8dcb2c86b4e1e8571c2c1362bd<br />
<br />
RESPONSE:<br />
<br />
<pre><br />
<?xml version="1.0" encoding="UTF-8"?><br />
<nftregistry><br />
<id>0d245973-1371-4271-b595-b87c4f7ae1ac</id><br />
<workCode>2204200018768</workCode><br />
<licenseIpfsUrl>ipfs://ipfs/QmSpSfkRPU4iBQh9Vq82Y6AGe86zjxUPyKP8RFn1dde4PF/info.html</licenseIpfsUrl><br />
</nftregistry><br />
</pre><br />
<br />
[[Category:API component]]</div>Adminwiki