Events

Developers

API Reference

Complete API documentation for integrating with the SOA event management platform. Build applications with our RESTful API.

RESTful API Overview

SOA provides a comprehensive REST API for event registration, results, affiliations, and platform integrations.

JWT sessions and Google sign-in
JSON Request/Response Format
Rate Limiting & Pagination
Public events, rankings, results, and certificate verification

Base URL

https://event.studentsolympic.com/backend/api/v1/

Authentication

Authentication

JWT Bearer TokenRequired
Token RefreshSupported
OAuth2 IntegrationAvailable

Access

Authenticated requestsJWT
Public readsOpen
Full referenceInteractive docs

Response Format

Content-Typeapplication/json
EncodingUTF-8
Date formatISO 8601

Error Handling

HTTP Status CodesStandard
Error MessagesDetailed
ValidationComprehensive

Security

HTTPS OnlyEnforced
CORSConfigured
Input ValidationStrict

Monitoring

Request LoggingEnabled
Performance MetricsAvailable
Health ChecksActive

Endpoints

API Endpoints

Explore all available endpoints organized by functionality.

Authentication

Email login, Google sign-in, and JWT session tokens

POST/api/v1/auth/login/
Email and password login
POST/api/v1/auth/register/
Create an account
POST/api/v1/auth/google/
Google sign-in
POST/api/v1/auth/token/refresh/
Refresh an access token
POST/api/v1/auth/logout/
End the session

Public Events, Results & Rankings

Read published events, activity catalogs, results, and standings without a login

GET/api/v1/public/events/
List published events
GET/api/v1/public/events/{id}/
Event details
GET/api/v1/public/activity-catalog/
Public activity catalog
GET/api/v1/public/events/{event_id}/rankings/
Event rankings
GET/api/v1/public/activities/{activity_id}/rankings/
Activity rankings
GET/api/v1/public/activities/{activity_id}/results/
Activity results

Certificates

Download your certificates and let anyone verify a QR or verification code

GET/api/v1/certs/my-certificates/
Certificates for the signed-in user
GET/api/v1/certs/certificates/verify/
Public certificate verification
GET/api/v1/certs/certificates/public-lookup/
Look up a certificate to download

Registrations, Payments & Rewards

Signed-in flows for event entry, Razorpay or offline payment, and reward claims

GET/api/v1/payments/transactions/
Payment history for the signed-in user
POST/api/v1/payments/razorpay/order/
Start an online Razorpay payment
POST/api/v1/payments/offline/create/
Submit an offline payment receipt
GET/api/v1/rewards/my-rewards/
Rewards for the signed-in user
POST/api/v1/rewards/rewards/{reward_id}/claim/
Claim a reward

Notifications

In-app alerts plus email, SMS, WhatsApp, and push delivery preferences

GET/api/v1/notifications/
In-app notifications
POST/api/v1/notifications/push/subscribe/
Register this device for push alerts
GET/api/v1/shared/profile/
Profile and account preferences

Code Examples

Get started quickly with these code examples in popular programming languages.

JavaScript/Node.js

const response = await fetch(
"https://event.studentsolympic.com/backend/api/v1/public/events/"
);
const events = await response.json();

Python

import requests
url = "https://event.studentsolympic.com/backend/api/v1/public/events/"
response = requests.get(url)
events = response.json()

Need integration help?

Contact our team or browse the full documentation.