File

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

Web3 Chain

Operations

Root

Operations

Balance

Operations

File

Operations

Get signed url for entity storage. This is needed to upload files to bucket

Request

Bodyapplication/jsonrequired
entityTypestringrequired

The entity type

Enum"token""campaign""redemption""business""tenant"
entityIdstringrequired

The entity id

signedUrlTypestringrequired

The signed url type, GET or PUT. PUT is used for uploading files, GET is used for downloading files

Enum"GET""PUT"
fileExtensionstringrequired

The file extension

fileNamestring

The file name

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger/file/entity-storage-url \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "entityType": "token",
    "entityId": "string",
    "signedUrlType": "GET",
    "fileExtension": "string",
    "fileName": "string"
  }'

Responses

The record has been successfully created.

Bodyapplication/json
signedUrlstringrequired

The signed url

Response
application/json
{
  "signedUrl": "string"
}