API Documentation

Technical documentation for integrating with the DEEP Education Network platform.

Overview

The DEEP Education Network API allows authorized partners and institutions to integrate platform features into their systems. Our API follows RESTful principles and uses JSON for data exchange.

Authentication

API access requires authentication using API keys. To obtain API access:

Contact our partnership team to request API access
Review and sign the API usage agreement
Receive your unique API credentials
Include your API key in request headers

Available Endpoints

Training Programs

GET /api/training/[programId]

Retrieve training program details and sessions. Requires valid access cookie.

Access Code Validation

POST /api/training/validate-code

Validate a training access code and grant program access.

Session Completion

POST /api/training/mark-complete

Mark a training session as completed (requires authentication).

Rate Limits

To ensure fair usage and platform stability, API requests are rate-limited. Standard limits apply unless otherwise specified in your partnership agreement.

Response Formats

All API responses are returned in JSON format. Successful requests return a 200 status code along with the requested data. Error responses include appropriate HTTP status codes and error messages.

Error Handling

400 - Bad Request: Invalid parameters

401 - Unauthorized: Invalid or missing authentication

403 - Forbidden: Insufficient permissions

404 - Not Found: Resource doesn't exist

500 - Internal Server Error: Server-side issue

Support

For API support, integration questions, or to request API access, please contact our technical team through the contact page or email api-support@deepprofessional.com.

Note: API access is currently available to institutional partners and authorized developers only. Individual user accounts do not have API access by default.