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
Operations

Request

Get all available redemption types for client reference. Requires valid project API key.

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

Responses

Redemption types retrieved

Bodyapplication/jsonArray [
namestringrequired

Redemption type name

descriptionstring

Redemption type description

imageUrlstring

Redemption type image url

idnumberrequired

Redemption type id

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

Request

Create a new redemption type for system configuration. Replaces POST /redemption/admin/type

Security
authJWT
Bodyapplication/jsonrequired
namestringrequired

Redemption type name

descriptionstring

Redemption type description

imageUrlstring

Redemption type image url

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

Responses

Redemption type created successfully

Bodyapplication/json
namestringrequired

Redemption type name

descriptionstring

Redemption type description

imageUrlstring

Redemption type image url

idnumberrequired

Redemption type id

Response
application/json
{ "name": "string", "description": "string", "imageUrl": "string", "id": 0 }
Operations
Operations
Operations