Skip to content

PERS-api Documentation (2.0.12)

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
Production API
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

Webhook Integration System

Webhook proxy and integration system for external service notifications. Handles incoming webhook events and integrates with external platforms for real-time data synchronization.
Webhook Features:

•
Webhook Proxy:
Secure proxy for external webhook integrations

•
Event Processing:
Real-time processing of external service events

•
Integration Management:
Manage connections with external platforms

•
Security Validation:
Webhook signature verification and authentication

•
Event Routing:
Intelligent routing of webhook events to appropriate handlers
Operations
Operations
Operations
Operations
Operations
Operations