Home About Pricing Contact Privacy Policy Terms of Service Login Get Started
Developers & Admins

API & Platform Docs

Everything you need to integrate, manage, and extend the Suivre Digital Library ecosystem.

Getting Started

Introduction Authentication Rate Limits

Core Resources

Students API Attendance API Fee Management API

Support

Help Center Contact Support

Introduction

Welcome to the official SDL API documentation. Our RESTful APIs allow schools and third-party developers to connect seamlessly with the SDL platform to sync data, automate tasks, and build custom integrations.

Base URL for all API requests:

https://api.suivredigital.com/v1

Prerequisites

To use the SDL API, you will need:

  • An active SDL Enterprise or Premium account.
  • Your unique School ID (found in Dashboard > Settings).
  • An API Key generated from the Admin Panel.

Authentication

All API requests must be authenticated using a Bearer Token. You can generate or regenerate your API key from the school dashboard settings.

Security Warning: Never expose your API key in client-side code (like JavaScript). Always use it in backend server-to-server requests.

Example Request Header

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

Rate Limits

To ensure platform stability, API requests are limited to 100 requests per minute per school account. If you exceed this limit, the API will return a 429 Too Many Requests response.

We recommend implementing exponential backoff retries in your integration scripts to handle rate limiting gracefully.

Students API

Use this endpoint to fetch, create, or update student records in real-time.

1. Get All Students

Retrieves a list of all active students associated with the authenticated school.

Endpoint: GET /students Response: 200 OK [ { "id": "SDL-STD-5001", "name": "Rahul Sharma", "class": "10-A", "roll_no": "12", "status": "active" } ]

Attendance API

Mark attendance for a specific class or student. This API triggers SMS alerts to parents automatically if configured.

1. Mark Attendance

Endpoint: POST /attendance/mark Body: { "class_id": "10-A", "date": "2024-09-05", "absentees": ["SDL-STD-5002", "SDL-STD-5005"] }

Fee Management API

Automate fee receipts and check pending dues for students.

1. Get Pending Fees

Endpoint: GET /fees/pending?student_id=SDL-STD-5001 Response: 200 OK { "student_id": "SDL-STD-5001", "total_due": 4500.00, "due_date": "2024-10-15" }
Need help integrating? If you get stuck, our technical team is available 24/7. Contact Developer Support.