Web3 Contract

PERS-api docs (1.7.2)

Download OpenAPI description
swagger.json
swagger.yaml
Overview
Languages
Servers
Mock server
https://docs.pers.ninja/_mock/swagger/
https://api.pers.ninja/v1.7/

Introduction

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:

  • Interoperable Rewards
  • Boost Customer Engagement
  • Simplified Management
  • Effortless Integration
  • Security and Privacy
  • Data-Driven Strategy PERS System

Setup Flow

This diagram illustrates the comprehensive flow of creating and connecting various components within the SaaS PERS ecosystem. It outlines the interactions and dependencies between Tokens, Campaigns, Redemptions, Purchase, and Business entities. API Flow

Claim Campaign

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. Claim System Flow 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.

Tenant

Operations

Token

Operations

Campaign

Operations

Redemption

Operations

Purchase

Operations

Business

Operations

Transaction

Operations

User

User endpoints

Operations

Admin

Operations

Auth

Operations

Web3 Contract

Operations

Create a new contract

Request

Bodyapplication/jsonrequired
implementationAddressstring

this is implementation address, the address of the contract that is being used as implementation for the proxy. This is only used for proxy contracts

contractAddressstringrequired

this is the address of the contract

ownerAddressstringrequired

this is the address of the owner of the contract

chainIdnumberrequired

this is the chain id of the contract

contractVersionstringrequired

this is the version of the contract

contractTypestringrequired

this is the type of the contract

Enum"SMART_WALLET_FACTORY""SMART_WALLET_IMPLEMENTATION""SMART_WALLET_PROXY""TOKEN_CONTRACT"
nativeTokenTypestringrequired

this is the native token type of the contract, this is only used for native tokens

Enum"ERC20""ERC721""ERC1155"
saltstring

this is the salt of the contract, this is only used for proxy contract factories to generate unique contracts

isProxybooleanrequired

this is the flag to check if the contract is a proxy contract

abiUrlstringrequired

this is the url of the abi of the contract, to be used to fetch the abi of the contract

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger/contract \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-project-key: YOUR_API_KEY_HERE' \
  -d '{
    "implementationAddress": "string",
    "contractAddress": "string",
    "ownerAddress": "string",
    "chainId": 0,
    "contractVersion": "string",
    "contractType": "SMART_WALLET_FACTORY",
    "nativeTokenType": "ERC20",
    "salt": "string",
    "isProxy": true,
    "abiUrl": "string"
  }'

Responses

Contract created

Bodyapplication/json
implementationAddressstring

this is implementation address, the address of the contract that is being used as implementation for the proxy. This is only used for proxy contracts

contractAddressstringrequired

this is the address of the contract

ownerAddressstringrequired

this is the address of the owner of the contract

chainIdnumberrequired

this is the chain id of the contract

contractVersionstringrequired

this is the version of the contract

contractTypestringrequired

this is the type of the contract

Enum"SMART_WALLET_FACTORY""SMART_WALLET_IMPLEMENTATION""SMART_WALLET_PROXY""TOKEN_CONTRACT"
nativeTokenTypestringrequired

this is the native token type of the contract, this is only used for native tokens

Enum"ERC20""ERC721""ERC1155"
saltstring

this is the salt of the contract, this is only used for proxy contract factories to generate unique contracts

isProxybooleanrequired

this is the flag to check if the contract is a proxy contract

abiUrlstringrequired

this is the url of the abi of the contract, to be used to fetch the abi of the contract

abiobjectrequired

this is the abi of the contract, this is the interface of the contract to interact with it

tenantIdobjectrequired

this is the tenant id of the contract, this can be null for generic contracts

Response
application/json
{
  "implementationAddress": "string",
  "contractAddress": "string",
  "ownerAddress": "string",
  "chainId": 0,
  "contractVersion": "string",
  "contractType": "SMART_WALLET_FACTORY",
  "nativeTokenType": "ERC20",
  "salt": "string",
  "isProxy": true,
  "abiUrl": "string",
  "abi": {},
  "tenantId": {}
}

Web3 Chain

Operations

Root

Operations

Balance

Operations

File

Operations