Introducing PERS (Phygital Experience Rewards System) the ultimate SaaS of Loyalty & Reward System. Connect PERS API to your system and get ready to create multi-projects, with your own dashboard and independent database, while ensuring users data confidentiality. This structure enables:
The Claim System Flow in SaaS PERS outlines the process through which rewards and tokens can be claimed by different entities within the system. This flow ensures that the claiming process is secure, efficient, and flexible, catering to various use cases and integration requirements. 
This flow ensures that the process of claiming rewards is adaptable to various scenarios, making it seamless for system administrators, business partners, and end-users to interact with the reward system efficiently.
The ABI URL is the URL to the contract ABI. This is an optional field. If not provided, the contract ABI will be fetched from PERS instance depending on selected token type.
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/token/admin \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"contractAddress": "string",
"abiUrl": "string",
"type": "ERC20",
"decimals": 0
}'Token created
this is the abi of the contract, this is the interface of the contract to interact with it
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
{ "id": "string", "contractAddress": "string", "metadata": {}, "abi": {}, "chainId": 0, "abiUrl": {}, "name": "string", "symbol": "string", "decimals": 0, "isActive": true, "isGallery": true, "type": "ERC20" }
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/token/admin/{id}/mainnet/{contractAddress}/chain/{chainId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Mainnet token Address created
this is the abi of the contract, this is the interface of the contract to interact with it
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
{ "id": "string", "contractAddress": "string", "metadata": {}, "abi": {}, "chainId": 0, "abiUrl": {}, "name": "string", "symbol": "string", "decimals": 0, "isActive": true, "isGallery": true, "type": "ERC20" }
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/token/admin/{id}/toggle-active' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Token toggled
this is the abi of the contract, this is the interface of the contract to interact with it
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
{ "id": "string", "contractAddress": "string", "metadata": {}, "abi": {}, "chainId": 0, "abiUrl": {}, "name": "string", "symbol": "string", "decimals": 0, "isActive": true, "isGallery": true, "type": "ERC20" }
This indicates if token should be included as a gallery. This is useful for ERC721 or ERC1155 tokens.
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/token/admin/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"isGallery": true,
"name": "string",
"symbol": "string"
}'Token updates
this is the abi of the contract, this is the interface of the contract to interact with it
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
{ "id": "string", "contractAddress": "string", "metadata": {}, "abi": {}, "chainId": 0, "abiUrl": {}, "name": "string", "symbol": "string", "decimals": 0, "isActive": true, "isGallery": true, "type": "ERC20" }
This is the URL to the image of the item. Can be just about any type of image (including SVGs, which will be cached into PNGs by OpenSea), IPFS or Arweave URLs or paths. We recommend using a minimum 3000 x 3000 image.
A URL to a multi-media attachment for the item. The file extensions GLTF, GLB, WEBM, MP4, M4V, OGV, and OGG are supported, along with the audio-only extensions MP3, WAV, and OGA. Animation_url also supports HTML pages, allowing you to build rich experiences and interactive NFTs using JavaScript canvas, WebGL, and more. Scripts and relative paths within the HTML page are now supported. However, access to browser extensions is not supported.
curl -i -X POST \
'https://docs.pers.ninja/_mock/swagger/token/admin/{id}/metadata' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"imageUrl": "string",
"externalUrl": "string",
"description": "string",
"name": "string",
"expiryDate": "2019-08-24T14:15:22Z",
"animationUrl": "string",
"youtubeUrl": "string",
"creatorAccountAddress": "string",
"previewUrl": "string"
}'Token metadata created
This is the URL to the image of the item. Can be just about any type of image (including SVGs, which will be cached into PNGs by OpenSea), IPFS or Arweave URLs or paths. We recommend using a minimum 3000 x 3000 image.
A URL to a multi-media attachment for the item. The file extensions GLTF, GLB, WEBM, MP4, M4V, OGV, and OGG are supported, along with the audio-only extensions MP3, WAV, and OGA. Animation_url also supports HTML pages, allowing you to build rich experiences and interactive NFTs using JavaScript canvas, WebGL, and more. Scripts and relative paths within the HTML page are now supported. However, access to browser extensions is not supported.
{ "imageUrl": "string", "externalUrl": "string", "description": "string", "name": "string", "expiryDate": "2019-08-24T14:15:22Z", "animationUrl": "string", "youtubeUrl": "string", "creatorAccountAddress": "string", "previewUrl": "string", "id": "string", "animationWeb3StorageUrl": "string", "imageWeb3StorageUrl": "string", "web3StorageUrl": "string", "tokenMetadataIncrementalId": 0, "isActive": true }
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger/token/admin/metadata/{id}/toggle-active' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Token metadata toggled
This is the URL to the image of the item. Can be just about any type of image (including SVGs, which will be cached into PNGs by OpenSea), IPFS or Arweave URLs or paths. We recommend using a minimum 3000 x 3000 image.
A URL to a multi-media attachment for the item. The file extensions GLTF, GLB, WEBM, MP4, M4V, OGV, and OGG are supported, along with the audio-only extensions MP3, WAV, and OGA. Animation_url also supports HTML pages, allowing you to build rich experiences and interactive NFTs using JavaScript canvas, WebGL, and more. Scripts and relative paths within the HTML page are now supported. However, access to browser extensions is not supported.
{ "imageUrl": "string", "externalUrl": "string", "description": "string", "name": "string", "expiryDate": "2019-08-24T14:15:22Z", "animationUrl": "string", "youtubeUrl": "string", "creatorAccountAddress": "string", "previewUrl": "string", "id": "string", "animationWeb3StorageUrl": "string", "imageWeb3StorageUrl": "string", "web3StorageUrl": "string", "tokenMetadataIncrementalId": 0, "isActive": true }
Token native Types:
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger/token/admin/type \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"nativeTokenType": "ERC20",
"name": "string",
"imageUrl": "string",
"description": "string"
}'{ "nativeTokenType": "ERC20", "name": "string", "imageUrl": "string", "description": "string" }
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/token/type \
-H 'x-project-key: YOUR_API_KEY_HERE'[ { "nativeTokenType": "ERC20", "name": "string", "imageUrl": "string", "description": "string" } ]
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/token?active=string' \
-H 'x-project-key: YOUR_API_KEY_HERE'Tokens
this is the abi of the contract, this is the interface of the contract to interact with it
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
This is the underlying web3 native type of the token contract
[ { "id": "string", "contractAddress": "string", "metadata": {}, "abi": {}, "chainId": 0, "abiUrl": {}, "name": "string", "symbol": "string", "decimals": 0, "isActive": true, "isGallery": true, "type": "ERC20" } ]
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger/token/credit \
-H 'x-project-key: YOUR_API_KEY_HERE'Credit token
this is the abi of the contract, this is the interface of the contract to interact with it
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
{ "id": "string", "contractAddress": "string", "metadata": {}, "abi": {}, "chainId": 0, "abiUrl": {}, "name": "string", "symbol": "string", "decimals": 0, "isActive": true, "isGallery": true, "type": "ERC20" }
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/token/reward?active=string' \
-H 'x-project-key: YOUR_API_KEY_HERE'Reward tokens
this is the abi of the contract, this is the interface of the contract to interact with it
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
This is the underlying web3 native type of the token contract
[ { "id": "string", "contractAddress": "string", "metadata": {}, "abi": {}, "chainId": 0, "abiUrl": {}, "name": "string", "symbol": "string", "decimals": 0, "isActive": true, "isGallery": true, "type": "ERC20" } ]
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger/token/status?active=string' \
-H 'x-project-key: YOUR_API_KEY_HERE'Status tokens
this is the abi of the contract, this is the interface of the contract to interact with it
this is the url of the abi of the contract, to be used to fetch the abi of the contract
this is the decimals of the token. This is optional and only used for ERC20 tokens (Points)
This is the underlying web3 native type of the token contract
[ { "id": "string", "contractAddress": "string", "metadata": {}, "abi": {}, "chainId": 0, "abiUrl": {}, "name": "string", "symbol": "string", "decimals": 0, "isActive": true, "isGallery": true, "type": "ERC20" } ]