PERS-api docs (1.8.1)
https://docs.pers.ninja/_mock/swagger-spec/
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
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.
The Business module encompasses all participants and partners involved in the reward system. This includes the partner community, such as vendors, service providers, artist community, commercial partners, public or private institutions and other entities that contribute to the reward ecosystem. Key features of the Business module include:
- Partner Management: Onboard and manage partners who participate in the reward system.
- Collaboration: Facilitate collaboration between the tenant and business partners to create cohesive and engaging reward campaigns.
- Incentive Structures: Develop and implement incentive structures that motivate partners to actively contribute to the reward system.
- Performance Tracking: Monitor the performance and engagement levels of business partners within the reward ecosystem.
- Community Building: Foster a sense of community among business participants to enhance the overall value and appeal of the reward program.
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/admin/type
https://api.pers.ninja/v1.8/business/admin/type
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/business/admin/type \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"description": "string",
"code": "string",
"iconUrl": "string"
}'{ "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/admin/type
https://api.pers.ninja/v1.8/business/admin/type
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://docs.pers.ninja/_mock/swagger-spec/business/admin/type \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"id": 0,
"name": "string",
"description": "string",
"code": "string",
"iconUrl": "string"
}'{ "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/admin/type/{id}
https://api.pers.ninja/v1.8/business/admin/type/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.pers.ninja/_mock/swagger-spec/business/admin/type/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/type
https://api.pers.ninja/v1.8/business/type
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/business/type \
-H 'x-project-key: YOUR_API_KEY_HERE'{ "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/business/me
https://api.pers.ninja/v1.8/business/business/me
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/business/business/me \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-H 'x-project-key: YOUR_API_KEY_HERE'Business found
The address of the business, this is the address that will be shown to the public.
The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public.
The business type of the business, this is the business type that will be shown to the public.
The status of the business, this is the status that will be shown to the public.
The ability to mint token for the business, this is the ability that will be shown to the public.
The ability to charge token for the business, this is the ability that will be shown to the public.
The ability to manage users for the business, this is the ability that will be shown to the public.
The ability to receive donation for the business, this is the ability that will be shown to the public.
The token balances of the business, this is the token balances that will be shown to the public.
{ "id": "string", "email": "string", "accountAddress": "string", "businessLegalName": "string", "displayName": "string", "description": "string", "shortDescription": "string", "websiteUrl": "string", "imageUrl": "string", "streetAddress": "string", "city": "string", "postalCode": "string", "coordsLatitude": 0, "coordsLongitude": 0, "businessType": { "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }, "isActive": true, "canMintToken": true, "canChargeToken": true, "canManageUsers": true, "canReceiveDonation": true, "tokenBalances": [ { … } ] }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business
https://api.pers.ninja/v1.8/business
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.pers.ninja/_mock/swagger-spec/business \
-H 'x-project-key: YOUR_API_KEY_HERE'Business found
The address of the business, this is the address that will be shown to the public.
The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public.
The business type of the business, this is the business type that will be shown to the public.
The status of the business, this is the status that will be shown to the public.
The ability to mint token for the business, this is the ability that will be shown to the public.
The ability to charge token for the business, this is the ability that will be shown to the public.
The ability to manage users for the business, this is the ability that will be shown to the public.
{ "id": "string", "email": "string", "accountAddress": "string", "businessLegalName": "string", "displayName": "string", "description": "string", "shortDescription": "string", "websiteUrl": "string", "imageUrl": "string", "streetAddress": "string", "city": "string", "postalCode": "string", "coordsLatitude": 0, "coordsLongitude": 0, "businessType": { "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }, "isActive": true, "canMintToken": true, "canChargeToken": true, "canManageUsers": true, "canReceiveDonation": true }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/admin
https://api.pers.ninja/v1.8/business/admin
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger-spec/business/admin?active=string&sanitize=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Business found
The address of the business, this is the address that will be shown to the public.
The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public.
The business type of the business, this is the business type that will be shown to the public.
The status of the business, this is the status that will be shown to the public.
The ability to mint token for the business, this is the ability that will be shown to the public.
The ability to charge token for the business, this is the ability that will be shown to the public.
The ability to manage users for the business, this is the ability that will be shown to the public.
{ "id": "string", "email": "string", "accountAddress": "string", "businessLegalName": "string", "displayName": "string", "description": "string", "shortDescription": "string", "websiteUrl": "string", "imageUrl": "string", "streetAddress": "string", "city": "string", "postalCode": "string", "coordsLatitude": 0, "coordsLongitude": 0, "businessType": { "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }, "isActive": true, "canMintToken": true, "canChargeToken": true, "canManageUsers": true, "canReceiveDonation": true }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/admin
https://api.pers.ninja/v1.8/business/admin
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.pers.ninja/_mock/swagger-spec/business/admin \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"displayName": "string"
}'Business created
The address of the business, this is the address that will be shown to the public.
The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public.
The business type of the business, this is the business type that will be shown to the public.
The status of the business, this is the status that will be shown to the public.
The ability to mint token for the business, this is the ability that will be shown to the public.
The ability to charge token for the business, this is the ability that will be shown to the public.
The ability to manage users for the business, this is the ability that will be shown to the public.
The ability to receive donation for the business, this is the ability that will be shown to the public.
{ "id": "string", "email": "string", "accountAddress": "string", "businessLegalName": "string", "displayName": "string", "description": "string", "shortDescription": "string", "websiteUrl": "string", "imageUrl": "string", "streetAddress": "string", "city": "string", "postalCode": "string", "coordsLatitude": 0, "coordsLongitude": 0, "businessType": { "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }, "isActive": true, "canMintToken": true, "canChargeToken": true, "canManageUsers": true, "canReceiveDonation": true, "apiPrivateKey": "string" }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/account/{accountAddress}
https://api.pers.ninja/v1.8/business/account/{accountAddress}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger-spec/business/account/{accountAddress}' \
-H 'x-project-key: YOUR_API_KEY_HERE'Business found
The address of the business, this is the address that will be shown to the public.
The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public.
The business type of the business, this is the business type that will be shown to the public.
The status of the business, this is the status that will be shown to the public.
The ability to mint token for the business, this is the ability that will be shown to the public.
The ability to charge token for the business, this is the ability that will be shown to the public.
The ability to manage users for the business, this is the ability that will be shown to the public.
{ "id": "string", "email": "string", "accountAddress": "string", "businessLegalName": "string", "displayName": "string", "description": "string", "shortDescription": "string", "websiteUrl": "string", "imageUrl": "string", "streetAddress": "string", "city": "string", "postalCode": "string", "coordsLatitude": 0, "coordsLongitude": 0, "businessType": { "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }, "isActive": true, "canMintToken": true, "canChargeToken": true, "canManageUsers": true, "canReceiveDonation": true }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/{id}
https://api.pers.ninja/v1.8/business/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.pers.ninja/_mock/swagger-spec/business/{id}' \
-H 'x-project-key: YOUR_API_KEY_HERE'Business found
The address of the business, this is the address that will be shown to the public.
The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public.
The business type of the business, this is the business type that will be shown to the public.
The status of the business, this is the status that will be shown to the public.
The ability to mint token for the business, this is the ability that will be shown to the public.
The ability to charge token for the business, this is the ability that will be shown to the public.
The ability to manage users for the business, this is the ability that will be shown to the public.
{ "id": "string", "email": "string", "accountAddress": "string", "businessLegalName": "string", "displayName": "string", "description": "string", "shortDescription": "string", "websiteUrl": "string", "imageUrl": "string", "streetAddress": "string", "city": "string", "postalCode": "string", "coordsLatitude": 0, "coordsLongitude": 0, "businessType": { "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }, "isActive": true, "canMintToken": true, "canChargeToken": true, "canManageUsers": true, "canReceiveDonation": true }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/admin/{id}/api-key
https://api.pers.ninja/v1.8/business/admin/{id}/api-key
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/business/admin/{id}/api-key' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/admin/{id}
https://api.pers.ninja/v1.8/business/admin/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/business/admin/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"email": "string",
"businessLegalName": "string",
"displayName": "string",
"description": "string",
"shortDescription": "string",
"websiteUrl": "string",
"imageUrl": "string",
"streetAddress": "string",
"city": "string",
"postalCode": "string",
"coordsLatitude": 0,
"coordsLongitude": 0,
"businessTypeId": 0
}'Business created
The address of the business, this is the address that will be shown to the public.
The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public.
The business type of the business, this is the business type that will be shown to the public.
The status of the business, this is the status that will be shown to the public.
The ability to mint token for the business, this is the ability that will be shown to the public.
The ability to charge token for the business, this is the ability that will be shown to the public.
The ability to manage users for the business, this is the ability that will be shown to the public.
The ability to receive donation for the business, this is the ability that will be shown to the public.
The token balances of the business, this is the token balances that will be shown to the public.
{ "id": "string", "email": "string", "accountAddress": "string", "businessLegalName": "string", "displayName": "string", "description": "string", "shortDescription": "string", "websiteUrl": "string", "imageUrl": "string", "streetAddress": "string", "city": "string", "postalCode": "string", "coordsLatitude": 0, "coordsLongitude": 0, "businessType": { "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }, "isActive": true, "canMintToken": true, "canChargeToken": true, "canManageUsers": true, "canReceiveDonation": true, "tokenBalances": [ { … } ] }
- Mock server
https://docs.pers.ninja/_mock/swagger-spec/business/admin/activate/{id}
https://api.pers.ninja/v1.8/business/admin/activate/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.pers.ninja/_mock/swagger-spec/business/admin/activate/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"isActive": true,
"canMintToken": true,
"canChargeToken": true,
"canManageUsers": true,
"canReceiveDonation": true
}'Business account permissions updated
The address of the business, this is the address that will be shown to the public.
The legal name of the business, this is the name that will be used for legal purposes.
The display name of the business, this is the name that will be shown to the public.
The description of the business, this is the description that will be shown to the public.
The short description of the business, this is the description that will be shown to the public.
The address of the business, this is the address that will be shown to the public.
The postal code of the business, this is the postal code that will be shown to the public.
The latitude of the business, this is the latitude that will be shown to the public.
The longitude of the business, this is the longitude that will be shown to the public.
The business type of the business, this is the business type that will be shown to the public.
The status of the business, this is the status that will be shown to the public.
The ability to mint token for the business, this is the ability that will be shown to the public.
The ability to charge token for the business, this is the ability that will be shown to the public.
The ability to manage users for the business, this is the ability that will be shown to the public.
{ "id": "string", "email": "string", "accountAddress": "string", "businessLegalName": "string", "displayName": "string", "description": "string", "shortDescription": "string", "websiteUrl": "string", "imageUrl": "string", "streetAddress": "string", "city": "string", "postalCode": "string", "coordsLatitude": 0, "coordsLongitude": 0, "businessType": { "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }, "isActive": true, "canMintToken": true, "canChargeToken": true, "canManageUsers": true, "canReceiveDonation": true }