⚡ Developer API

Build with theEduUps API

Powerful, developer-friendly REST API to integrate EduUps with your applications and create custom solutions for your academy.

API Overview

Our RESTful API provides programmatic access to all EduUps features and data.

🚀

RESTful Design

Clean, predictable URLs and standard HTTP methods make integration simple and intuitive.

🔒

Secure Authentication

OAuth 2.0 and API key authentication with granular permission controls.

📊

Real-time Data

Access live data with webhooks for instant notifications of changes.

📖

Comprehensive Docs

Detailed documentation with examples, SDKs, and interactive API explorer.

⚡

High Performance

Fast response times with rate limiting and caching for optimal performance.

🔧

Developer Tools

SDKs, Postman collections, and CLI tools to speed up development.

Core API Endpoints

Explore the main API endpoints available for integration.

GET
/api/v1/academies

Academies

Manage academy information, settings, and configuration.

Common endpoints:

GET /api/v1/academiesGET /api/v1/academies/{id}POST /api/v1/academiesPUT /api/v1/academies/{id}
GET
/api/v1/students

Students

Complete student management including profiles, enrollment, and progress.

Common endpoints:

GET /api/v1/studentsGET /api/v1/students/{id}POST /api/v1/studentsPUT /api/v1/students/{id}/progress
GET
/api/v1/teachers

Teachers

Teacher profiles, availability, and assignment management.

Common endpoints:

GET /api/v1/teachersGET /api/v1/teachers/{id}/availabilityPOST /api/v1/teachersPUT /api/v1/teachers/{id}/schedule
GET
/api/v1/sessions

Sessions

Session scheduling, management, and tracking functionality.

Common endpoints:

GET /api/v1/sessionsPOST /api/v1/sessionsPUT /api/v1/sessions/{id}/statusGET /api/v1/sessions/{id}/feedback
GET
/api/v1/payments

Payments

Payment processing, invoicing, and financial transaction management.

Common endpoints:

GET /api/v1/paymentsPOST /api/v1/payments/intentGET /api/v1/invoicesPOST /api/v1/invoices/{id}/send
GET
/api/v1/analytics

Analytics

Performance metrics, reports, and data insights.

Common endpoints:

GET /api/v1/analytics/overviewGET /api/v1/analytics/studentsGET /api/v1/analytics/revenueGET /api/v1/reports/custom

Getting Started

Follow these simple steps to start using the EduUps API.

1

Get API Credentials

Create an API key in your EduUps dashboard to authenticate your requests.

// Get your API key from Dashboard > Settings > API
const apiKey = 'eduups_live_abc123...';
2

Make Your First Request

Test the API with a simple request to get academy information.

curl -X GET \
  https://api.eduups.com/v1/academies \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
3

Handle the Response

Process the JSON response and handle any errors appropriately.

{
  "data": {
    "id": "academy_123",
    "name": "Bright Minds Academy",
    "status": "active"
  },
  "meta": {
    "timestamp": "2025-01-01T00:00:00Z"
  }
}

SDKs & Developer Tools

Use our official SDKs and tools to speed up your development process.

JavaScript/Node.js SDK

Available

Official SDK for JavaScript and Node.js applications

npm install @eduups/api

Python SDK

Available

Python library for seamless API integration

pip install eduups-api

PHP SDK

Coming Soon

PHP package for web applications and Laravel

composer require eduups/api

Postman Collection

Available

Pre-configured requests for API testing

Import from Postman

OpenAPI Spec

Available

Machine-readable API specification

Download OpenAPI 3.0

CLI Tool

Coming Soon

Command-line interface for API operations

npm install -g @eduups/cli

Start Building Today

Join developers who are already building amazing integrations with the EduUps API.

Get API AccessContact Support