Skip to content

PERS-api docs (2.0.7)

Download OpenAPI description
Overview
Languages
Servers
Mock server
https://docs.pers.ninja/_mock/swagger/
https://explorins-loyalty.ngrok.io/
https://api.pers.ninja/v2/

Tenants

Operations

Admins

Operations

Tokens

Operations

Campaigns

Operations

Campaign Tags

Operations

Campaign Tokens

Operations

Campaign Triggers

Operations

Campaign Engagements

Operations

Campaign Claims

Operations

Redemptions

Operations

Purchases

Operations

Businesses

Operations

Transactions

Operations

Users

Operations

Balances

Operations

Files

Operations

Web3 Chains

Operations

Contracts

Operations

Auth

Operations

Root

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

RootController_get

Request

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

Responses

RootController_getCurrentTime

Request

Security
projectKey and businessApiKey
curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/healthcheck \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -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
projectKey and businessApiKey
curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/system \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

ADMIN: Check if admin

Request

Get if admin

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

Responses

RootController_testGeo

Request

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

Responses

Well-known

Operations

webhooks

Business Types

Operations

Redemption Types

Operations

Redemption Redeems

Operations

Redemption Tokens

Operations

API Keys

Operations