PERS-api docs (1.8.2)

Download OpenAPI description

swagger.json

swagger.yaml

Overview

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

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. 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

Description

The Tenant module in SaaS PERS represents the business or organization that leads the reward and loyalty program. As the primary administrator, the tenant has overarching control over the configuration and management of the loyalty and reward system. Key responsibilities and features for the tenant include:

Program Management: Define and oversee the overall structure and rules of the reward program.
Dashboard Access: Utilize a comprehensive dashboard to monitor and manage all aspects of the reward system.
Data Confidentiality: Ensure that all user data within the system is handled with the highest level of confidentiality and security.
Customization: Tailor the reward system to align with the business's unique objectives and customer engagement strategies.
Integration: Seamlessly integrate the reward system with existing business systems and processes through the PERS API.

Create a new tenant

Request

Create a new tenant aka project

Bodyapplication/jsonrequired

projectNamestringrequired

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger/tenant \
  -H 'Content-Type: application/json' \
  -d '{
    "projectName": "string"
  }'

Responses

Tenant created

Bodyapplication/json

projectNamestringrequired

Name of the tenant.

acronymstringrequired

Acronym of the tenant.

idstringrequired

Unique identifier for tenant. This id is used to identify tenant in the system for client requests.

createdAtstring(date-time)required

Date when tenant was created.

projectDescriptionstring

Description of the tenant.

projectWebsitestring

Website of the tenant.

projectEmailstring

Email of the tenant.

projectImageUrlstring

Image URL of the tenant.

projectApiKeystringrequired

Unique identifier for tenant. This id is used to identify tenant in the system for client requests.

testnetProjectApiKeystringrequired

Testnet project API key for tenant. Used in case of testnet project.

stripeApiKeystring

Stripe API key for tenant. Used in case of stripe payment.

stripeWebhookSecretstring

Stripe webhook secret for tenant. Used in case of stripe payment.

loginTokenstring

This is an optional field for any extra login requirements for your users.

allowJWTForUnauthenticatedUsersbooleanrequired

This is an optional field for any extra login requirements for your users.

firebaseTenantIdstring

jwtstring

JWT token for tenant admin user. This token is used to authenticate tenant admin user. It is generated when tenant is created. Please store it securely, you will not be able to see this again. However, you can generate a new one if needed.

apiPrivateKeystring

API private key for tenant. This key is used to authenticate tenant when making API requests. It is generated on demand. Please store it securely, you will not be able to see this again. However, you can generate a new one if needed.

Response

application/json

{
  "projectName": "string",
  "acronym": "string",
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "projectDescription": "string",
  "projectWebsite": "string",
  "projectEmail": "string",
  "projectImageUrl": "string",
  "projectApiKey": "string",
  "testnetProjectApiKey": "string",
  "stripeApiKey": "string",
  "stripeWebhookSecret": "string",
  "loginToken": "string",
  "allowJWTForUnauthenticatedUsers": true,
  "firebaseTenantId": "string",
  "jwt": "string",
  "apiPrivateKey": "string"
}

ADMIN: Create a new api key for tenant with tenant admin credentials

Request

Create a new api key for tenant with tenant admin credentials. Store this key securely, you will not be able to see this again

Bodyapplication/jsonrequired

keyNamestringrequired

name of the key

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger/tenant/admin/api-key \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "keyName": "string"
  }'

Responses

Api key created

Bodyapplication/json

projectNamestringrequired

Name of the tenant.

acronymstringrequired

Acronym of the tenant.

idstringrequired

Unique identifier for tenant. This id is used to identify tenant in the system for client requests.

createdAtstring(date-time)required

Date when tenant was created.

projectDescriptionstring

Description of the tenant.

projectWebsitestring

Website of the tenant.

projectEmailstring

Email of the tenant.

projectImageUrlstring

Image URL of the tenant.

projectApiKeystringrequired

Unique identifier for tenant. This id is used to identify tenant in the system for client requests.

testnetProjectApiKeystringrequired

Testnet project API key for tenant. Used in case of testnet project.

stripeApiKeystring

Stripe API key for tenant. Used in case of stripe payment.

stripeWebhookSecretstring

Stripe webhook secret for tenant. Used in case of stripe payment.

loginTokenstring

This is an optional field for any extra login requirements for your users.

allowJWTForUnauthenticatedUsersbooleanrequired

This is an optional field for any extra login requirements for your users.

firebaseTenantIdstring

jwtstring

apiPrivateKeystring

Response

application/json

{
  "projectName": "string",
  "acronym": "string",
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "projectDescription": "string",
  "projectWebsite": "string",
  "projectEmail": "string",
  "projectImageUrl": "string",
  "projectApiKey": "string",
  "testnetProjectApiKey": "string",
  "stripeApiKey": "string",
  "stripeWebhookSecret": "string",
  "loginToken": "string",
  "allowJWTForUnauthenticatedUsers": true,
  "firebaseTenantId": "string",
  "jwt": "string",
  "apiPrivateKey": "string"
}

ADMIN: Create a new jwt token for tenant with tenant admin credentials

Request

Create a new jwt token for tenant with tenant admin credentials. Store this key securely, you will not be able to see this again

Bodyapplication/jsonrequired

isTestnetbooleanrequired

wheter the key is for testnet or mainnet

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger/tenant/admin/jwt \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "isTestnet": true
  }'

Responses

Api key created

Bodyapplication/json

projectNamestringrequired

Name of the tenant.

acronymstringrequired

Acronym of the tenant.

idstringrequired

Unique identifier for tenant. This id is used to identify tenant in the system for client requests.

createdAtstring(date-time)required

Date when tenant was created.

projectDescriptionstring

Description of the tenant.

projectWebsitestring

Website of the tenant.

projectEmailstring

Email of the tenant.

projectImageUrlstring

Image URL of the tenant.

projectApiKeystringrequired

Unique identifier for tenant. This id is used to identify tenant in the system for client requests.

testnetProjectApiKeystringrequired

Testnet project API key for tenant. Used in case of testnet project.

stripeApiKeystring

Stripe API key for tenant. Used in case of stripe payment.

stripeWebhookSecretstring

Stripe webhook secret for tenant. Used in case of stripe payment.

loginTokenstring

This is an optional field for any extra login requirements for your users.

allowJWTForUnauthenticatedUsersbooleanrequired

This is an optional field for any extra login requirements for your users.

firebaseTenantIdstring

jwtstring

apiPrivateKeystring

Response

application/json

{
  "projectName": "string",
  "acronym": "string",
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "projectDescription": "string",
  "projectWebsite": "string",
  "projectEmail": "string",
  "projectImageUrl": "string",
  "projectApiKey": "string",
  "testnetProjectApiKey": "string",
  "stripeApiKey": "string",
  "stripeWebhookSecret": "string",
  "loginToken": "string",
  "allowJWTForUnauthenticatedUsers": true,
  "firebaseTenantId": "string",
  "jwt": "string",
  "apiPrivateKey": "string"
}

ADMIN: Update tenant

Request

Update tenant information

Bodyapplication/jsonrequired

projectNamestring

The project name

Example: "My Project"

projectDescriptionstring

The project description

stripeApiKeystring

stripeWebhookSecretstring

stripePublishableKeystring

loginTokenstring

allowJWTForUnauthenticatedUsersboolean

This is an optional field for any extra login requirements for your users.

firebaseTenantIdstring

projectWebsitestring

projectEmailstring

projectImageUrlstring

curl -i -X PUT \
  https://docs.pers.ninja/_mock/swagger/tenant/admin \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "projectName": "My Project",
    "projectDescription": "string",
    "stripeApiKey": "string",
    "stripeWebhookSecret": "string",
    "stripePublishableKey": "string",
    "loginToken": "string",
    "allowJWTForUnauthenticatedUsers": true,
    "firebaseTenantId": "string",
    "projectWebsite": "string",
    "projectEmail": "string",
    "projectImageUrl": "string"
  }'

Responses

Tenant updated

Bodyapplication/json

projectNamestringrequired

Name of the tenant.

acronymstringrequired

Acronym of the tenant.

idstringrequired

Unique identifier for tenant. This id is used to identify tenant in the system for client requests.

createdAtstring(date-time)required

Date when tenant was created.

projectDescriptionstring

Description of the tenant.

projectWebsitestring

Website of the tenant.

projectEmailstring

Email of the tenant.

projectImageUrlstring

Image URL of the tenant.

projectApiKeystringrequired

Unique identifier for tenant. This id is used to identify tenant in the system for client requests.

testnetProjectApiKeystringrequired

Testnet project API key for tenant. Used in case of testnet project.

stripeApiKeystring

Stripe API key for tenant. Used in case of stripe payment.

stripeWebhookSecretstring

Stripe webhook secret for tenant. Used in case of stripe payment.

loginTokenstring

This is an optional field for any extra login requirements for your users.

allowJWTForUnauthenticatedUsersbooleanrequired

This is an optional field for any extra login requirements for your users.

firebaseTenantIdstring

jwtstring

apiPrivateKeystring

Response

application/json

{
  "projectName": "string",
  "acronym": "string",
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "projectDescription": "string",
  "projectWebsite": "string",
  "projectEmail": "string",
  "projectImageUrl": "string",
  "projectApiKey": "string",
  "testnetProjectApiKey": "string",
  "stripeApiKey": "string",
  "stripeWebhookSecret": "string",
  "loginToken": "string",
  "allowJWTForUnauthenticatedUsers": true,
  "firebaseTenantId": "string",
  "jwt": "string",
  "apiPrivateKey": "string"
}

Get login token

Request

Get login token for project

curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/tenant/login-token \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

string

Response

application/json

"string"

Get public tenant

Request

Get public tenant information

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

Responses

Tenant information

Bodyapplication/json

projectNamestringrequired

Name of the tenant.

acronymstringrequired

Acronym of the tenant.

idstringrequired

Unique identifier for tenant. This id is used to identify tenant in the system for client requests.

createdAtstring(date-time)required

Date when tenant was created.

projectDescriptionstring

Description of the tenant.

projectWebsitestring

Website of the tenant.

projectEmailstring

Email of the tenant.

projectImageUrlstring

Image URL of the tenant.

Response

application/json

{
  "projectName": "string",
  "acronym": "string",
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "projectDescription": "string",
  "projectWebsite": "string",
  "projectEmail": "string",
  "projectImageUrl": "string"
}

Get client config

Request

Get client config for project

curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/tenant/client-config \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Client config

Bodyapplication/json

projectNamestringrequired

The project name

Example: "My Project"

idstringrequired

The project id

Example: "ererf-erf-erf-erf"

stripePublishableKeystring

Stripe publishable key for tenant. Used in case of stripe payment.

firebaseTenantIdstring

Firebase tenant ID for tenant. This id is needed, if you choose to setup Firebase for user authentification for your project.

infuraApiKeystring

Infura API key for tenant. Used in for client interaction with web3 provider.

polyScanApiKeystring

PolyScan API key for tenant. Used in for client interaction with PolyScan.

clientIpLocationobject or null

Geolocation information derived from the client IP address

Response

application/json

{
  "projectName": "My Project",
  "id": "ererf-erf-erf-erf",
  "stripePublishableKey": "string",
  "firebaseTenantId": "string",
  "infuraApiKey": "string",
  "polyScanApiKey": "string",
  "clientIpLocation": {
    "country_code": "string",
    "country_name": "string",
    "region_code": "string",
    "region_name": "string",
    "city_name": "string",
    "postal_code": "string",
    "latitude": 37.7749,
    "longitude": -122.4194,
    "accuracy_radius": 5
  }
}

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

PERS-api docs (1.8.2)

Introduction

Setup Flow

Claim Campaign

Tenant

Description

Create a new tenant

Request

Responses

Was this helpful?

ADMIN: Create a new api key for tenant with tenant admin credentials

Request

Responses

Was this helpful?

ADMIN: Create a new jwt token for tenant with tenant admin credentials

Request

Responses

Was this helpful?

ADMIN: Update tenant

Request

Responses

Was this helpful?

Get login token

Request

Responses

Was this helpful?

Get public tenant

Request

Responses

Was this helpful?

Get client config

Request

Responses

Was this helpful?

Token

Campaign

Redemption

Purchase

Business

Transaction

User

Admin

Auth

Web3 Contract

Web3 Chain

Root

Balance

File