Skip to content

PERS-api Documentation (2.0.13)

PERS API Documentation

This RESTful API enables seamless integration of Web3 loyalty, token management, and engagement features into your applications.

Usage Guidelines:

  • RESTful Design: Resources are accessed via standard HTTP methods (GET, POST, PUT, DELETE) with predictable, resource-oriented URLs.
  • Authentication: Secure access is enforced via Bearer Tokens (JWT) and Project Keys (defining the Tenant context).
  • Data Format: All requests and responses utilize standard JSON formatting.

Explore the modules below for detailed endpoint specifications, schemas, and testing capabilities.

Download OpenAPI description
Overview
Languages
Servers
Mock server
https://docs.pers.ninja/_mock/swagger
https://api.pers.ninja/v2
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Request

Create a new business type

Security
authJWT
Bodyapplication/jsonrequired
namestringrequired

Business type name

descriptionstringrequired

Business type description

codestring

Business type code

iconUrlstring

Business type icon url

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger/businesses/types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "code": "string",
    "iconUrl": "string"
  }'

Responses

Business type created

Bodyapplication/json
idnumber

Business type id

namestring or nullrequired

Business type name

descriptionstring or nullrequired

Business type description

codestring or nullrequired

Business type code

iconUrlstring or nullrequired

Business type icon url

Response
application/json
{ "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }

Request

Update a business type

Security
authJWT
Bodyapplication/jsonrequired
idnumber

Business type id

namestring or nullrequired

Business type name

descriptionstring or nullrequired

Business type description

codestring or nullrequired

Business type code

iconUrlstring or nullrequired

Business type icon url

curl -i -X PUT \
  https://docs.pers.ninja/_mock/swagger/businesses/types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "name": "string",
    "description": "string",
    "code": "string",
    "iconUrl": "string"
  }'

Responses

Business type updated

Bodyapplication/json
idnumber

Business type id

namestring or nullrequired

Business type name

descriptionstring or nullrequired

Business type description

codestring or nullrequired

Business type code

iconUrlstring or nullrequired

Business type icon url

Response
application/json
{ "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" }

Request

Get all business types

Security
projectKey
curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/businesses/types \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Business types found

Bodyapplication/jsonArray [
idnumber

Business type id

namestring or nullrequired

Business type name

descriptionstring or nullrequired

Business type description

codestring or nullrequired

Business type code

iconUrlstring or nullrequired

Business type icon url

]
Response
application/json
[ { "id": 0, "name": "string", "description": "string", "code": "string", "iconUrl": "string" } ]

Request

Delete a business type

Security
authJWT
Path
idstringrequired
curl -i -X DELETE \
  'https://docs.pers.ninja/_mock/swagger/businesses/types/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Business type deleted

Bodyapplication/json
boolean
Response
application/json
true
Operations
Operations
Operations
Operations