User

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

AUTH USER: Get user info without balances

Request

Get a user account by auth and return w/o token balance

curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/user/auth/me \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

User found

Bodyapplication/json
idstringrequired
emailobject
firstNameobjectrequired

User first name

lastNameobjectrequired

User last name

externalIdobjectrequired

User external id

accountAddressstringrequired

User account address

instagramAccountIdobjectrequired

Instagram account id

googleAccountNameobjectrequired

Google account name

Response
application/json
{
  "id": "string",
  "email": {},
  "firstName": {},
  "lastName": {},
  "externalId": {},
  "accountAddress": "string",
  "instagramAccountId": {},
  "googleAccountName": {}
}

AUTH USER: Update user account

Request

Update user account

Bodyapplication/jsonrequired
emailstring
instagramAccountIdstring

User Instagram account id

googleAccountNamestring

User Google account name

firstNamestring

User first name

lastNamestring

User last name

externalIdstring

User external id

curl -i -X PUT \
  https://docs.pers.ninja/_mock/swagger/user/auth/me \
  -H 'Content-Type: application/json' \
  -H 'x-project-key: YOUR_API_KEY_HERE' \
  -d '{
    "email": "string",
    "instagramAccountId": "string",
    "googleAccountName": "string",
    "firstName": "string",
    "lastName": "string",
    "externalId": "string"
  }'

Responses

User updated

Bodyapplication/json
idstringrequired
emailobject
firstNameobjectrequired

User first name

lastNameobjectrequired

User last name

externalIdobjectrequired

User external id

accountAddressstringrequired

User account address

instagramAccountIdobjectrequired

Instagram account id

googleAccountNameobjectrequired

Google account name

tokenBalancesArray of objects(TokenBalanceDTO)required
tokenBalances[].​contractAddressstringrequired
tokenBalances[].​chainIdnumberrequired
tokenBalances[].​balancenumberrequired
tokenBalances[].​tokenNamestring
tokenBalances[].​tokenSymbolstring
tokenBalances[].​tokenTypestringrequired
Enum"ERC20""ERC721""ERC1155"
tokenBalances[].​tokenIdstring or nullrequired
tokenBalances[].​metadataUristring or nullrequired
Response
application/json
{
  "id": "string",
  "email": {},
  "firstName": {},
  "lastName": {},
  "externalId": {},
  "accountAddress": "string",
  "instagramAccountId": {},
  "googleAccountName": {},
  "tokenBalances": [
    { … }
  ]
}

BUSINESS: Get a user info without balances

Request

Get a user account by auth and return w/o token balance

Bodyapplication/jsonrequired
emailstring
instagramAccountIdstring

User Instagram account id

googleAccountNamestring

User Google account name

firstNamestring

User first name

lastNamestring

User last name

externalIdstring

User external id

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger/user/business/info \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-project-key: YOUR_API_KEY_HERE' \
  -d '{
    "email": "string",
    "instagramAccountId": "string",
    "googleAccountName": "string",
    "firstName": "string",
    "lastName": "string",
    "externalId": "string"
  }'

Responses

User found

Bodyapplication/json
idstringrequired
emailobject
firstNameobjectrequired

User first name

lastNameobjectrequired

User last name

externalIdobjectrequired

User external id

accountAddressstringrequired

User account address

instagramAccountIdobjectrequired

Instagram account id

googleAccountNameobjectrequired

Google account name

tokenBalancesArray of objects(TokenBalanceDTO)required
tokenBalances[].​contractAddressstringrequired
tokenBalances[].​chainIdnumberrequired
tokenBalances[].​balancenumberrequired
tokenBalances[].​tokenNamestring
tokenBalances[].​tokenSymbolstring
tokenBalances[].​tokenTypestringrequired
Enum"ERC20""ERC721""ERC1155"
tokenBalances[].​tokenIdstring or nullrequired
tokenBalances[].​metadataUristring or nullrequired
Response
application/json
{
  "id": "string",
  "email": {},
  "firstName": {},
  "lastName": {},
  "externalId": {},
  "accountAddress": "string",
  "instagramAccountId": {},
  "googleAccountName": {},
  "tokenBalances": [
    { … }
  ]
}

Admin

Operations

Auth

Operations

Web3 Contract

Operations

Web3 Chain

Operations

Root

Operations

Balance

Operations

File

Operations