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

Platform Infrastructure

Core platform infrastructure endpoints including health checks, system status, and platform configuration. Provides essential system-level operations and monitoring.
Infrastructure Operations:

•
Health Monitoring:
System health checks and status reporting

•
Platform Status:
Real-time platform operational status

•
Configuration Access:
System configuration and environment information

•
Diagnostic Tools:
Platform diagnostics and troubleshooting endpoints

•
System Integration:
Core infrastructure for system-level operations

Request

curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/

Responses

Request

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

Responses

Check if tenant system api key is valid

Request

Check if tenant system api key is valid

Security
authJWT
curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/system \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Request

Get if admin

Security
authJWT
curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/admin \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Request

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

Responses

Operations
Operations
Operations
Operations
Operations
Operations
Operations