Auth

PERS-api docs (1.8.2)

Download OpenAPI description
swagger.json
swagger.yaml
Overview
Languages
Servers
Mock server

https://docs.pers.ninja/_mock/swagger/

https://explorins-loyalty.ngrok.io/

https://api.pers.ninja/v1.8/

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

Login

Request

Login tenant admin and get JWT tokens

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger/auth/admin/login \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Admin successfully logged-in

Bodyapplication/json
accessTokenstringrequired

JWT access token this token is used to authenticate the user, by default it expires in 15 minutes, and it should be sent in the Authorization header as Bearer token.

refreshTokenstringrequired

JWT refresh token this token is used to get a new access token when the current one expires. It is valid for 1 day.

adminobjectrequired

Admin

admin.​idstringrequired

Id of the admin

admin.​emailstringrequired

Email of the admin

admin.​displayNameobjectrequired

Display name of the admin

admin.​typestringrequired

Type of the admin

Enum"SUPER_ADMIN""TENANT_ADMIN"
admin.​tenantsobject

Tenant of the admin

Response
application/json
{
  "accessToken": "string",
  "refreshToken": "string",
  "admin": {
    "id": "string",
    "email": "string",
    "displayName": {},
    "type": "SUPER_ADMIN",
    "tenants": {}
  }
}

Refresh

Request

Refresh the access token

Bodyapplication/jsonrequired
refreshTokenstringrequired

refresh token

Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZW5hbnRJZCI6IjEiLCJpYXQiOjE2MjYxNzUwNzksImV4cCI6MTYyNjE3NTI3OX0.5w8A6t7b5lBx8D3FmLwJQgJ9z1D9c9Vz7A3f7BvzH2A"
curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger/auth/refresh \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-project-key: YOUR_API_KEY_HERE' \
  -d '{
    "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZW5hbnRJZCI6IjEiLCJpYXQiOjE2MjYxNzUwNzksImV4cCI6MTYyNjE3NTI3OX0.5w8A6t7b5lBx8D3FmLwJQgJ9z1D9c9Vz7A3f7BvzH2A"
  }'

Responses

New access token created

Bodyapplication/json
accessTokenstringrequired

JWT access token this token is used to authenticate the user, by default it expires in 15 minutes, and it should be sent in the Authorization header as Bearer token.

refreshTokenstringrequired

JWT refresh token this token is used to get a new access token when the current one expires. It is valid for 1 day.

Response
application/json
{
  "accessToken": "string",
  "refreshToken": "string"
}

Web3 Contract

Operations

Web3 Chain

Operations

Root

Operations

Balance

Operations

File

Operations