API Documentation

Appearance

Engagifii Training & Accreditation API Documentation ​

Project Overview ​

The Engagifii Training & Accreditation API is a comprehensive enterprise-level solution for managing professional training, certifications, and educational programs. This RESTful API enables organizations to handle complex workflows for course management, class registrations, award tracking, credit management, and multi-tenant operations.

Key Capabilities ​

  • Training Management: Complete lifecycle management for courses, classes, and educational programs
  • Award & Certification System: Track professional certifications, awards, and member achievements
  • Credit Management: Handle credit requests, transfers, and earned credits across programs
  • Registration Workflows: Sophisticated approval workflows for class and award registrations
  • Multi-tenant Architecture: Secure isolation and customization for multiple organizations
  • Reporting & Analytics: Comprehensive reporting on training metrics and member progress

Quick Start Guide ​

Get up and running with the Engagifii API in 5 minutes:

1. Obtain API Access ​

bash
# Request API credentials from your administrator
# You'll receive:
# - Tenant Code (required for all requests)
# - API Key or OAuth credentials (if applicable)

2. Set Base URL ​

javascript
const BASE_URL = 'https://engagifii-trainingandaccreditation.azurewebsites.net';
const API_VERSION = 'v1';

3. Make Your First API Call ​

javascript
// Example: Get list of awards
fetch(`${BASE_URL}/api/${API_VERSION}/Awards/List`, {
  headers: {
    'tenant-code': 'YOUR_TENANT_CODE',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log('Awards:', data));

4. Explore the API ​

Base URLs ​

EnvironmentBase URLPurpose
Productionhttps://engagifii-trainingandaccreditation.azurewebsites.netLive production environment
StagingContact administrator for URLPre-production testing
DevelopmentContact administrator for URLDevelopment and integration testing

API Versioning ​

The API uses URL path versioning to ensure backward compatibility:

  • Current Version: v1
  • Version Format: /api/v{version}/[endpoint]
  • Example: /api/v1/Awards/List

Version Policy ​

  • Major versions are indicated in the URL path
  • Minor updates maintain backward compatibility
  • Breaking changes require a new major version
  • Deprecated versions supported for 12 months minimum

API Categories ​

The API is organized into logical resource categories:

CategoryEndpointsDescription
Awards55Manage certifications and professional awards
Classes104Handle class creation, scheduling, and management
Courses89Course curriculum and content management
Registration79Registration workflows and approvals
Credit Management52Credit requests, transfers, and tracking
People5Member and user management
Organizations21Organizational hierarchy and settings
ReportingVariousAnalytics and reporting endpoints

Key Features ​

🔐 Security & Authentication ​

  • Multi-tenant architecture with tenant isolation
  • Header-based authentication using tenant-code
  • Support for JWT bearer tokens
  • Role-based access control (RBAC)

📊 Data Management ​

  • Comprehensive CRUD operations
  • Advanced filtering and pagination
  • Bulk operations support
  • Real-time data synchronization

🔄 Workflow Management ​

  • Approval workflows for registrations
  • Automated notification system
  • Status tracking and audit trails
  • Configurable business rules

📈 Reporting & Analytics ​

  • Real-time statistics
  • Custom report generation
  • Export capabilities (PDF, Excel)
  • Dashboard metrics

Support Information ​

Getting Help ​

  • Technical Documentation: This documentation site
  • API Status: Check Swagger UI
  • Support Email: Contact your administrator
  • Response Time: 24-48 hours for standard inquiries

Reporting Issues ​

When reporting issues, please include:

  1. API endpoint being called
  2. Request headers and body
  3. Error response received
  4. Timestamp of the request
  5. Your tenant code (do not share credentials)

Feature Requests ​

Submit feature requests through your organization's administrator, including:

  • Use case description
  • Business justification
  • Expected behavior
  • Priority level

Prerequisites ​

Before integrating with the API:

  • ✅ Obtain tenant code from your administrator
  • ✅ Ensure HTTPS support in your application
  • ✅ Implement proper error handling
  • ✅ Review rate limiting guidelines
  • ✅ Understand data retention policies

Rate Limiting ​

The API implements rate limiting to ensure fair usage:

  • Default Limit: 1000 requests per minute per tenant
  • Burst Limit: 50 concurrent requests
  • Headers: Rate limit status returned in response headers
  • Retry Strategy: Implement exponential backoff

Compliance & Security ​

  • Data Protection: GDPR compliant data handling
  • Encryption: TLS 1.2+ for all connections
  • Audit Logging: All API calls are logged
  • Data Residency: Configurable per tenant

Next Steps ​

  1. Review the Getting Started Guide for detailed setup
  2. Explore the API Reference for endpoint details
  3. Download the Postman Collection for testing
  4. Check API Reference for code examples

Last Updated: January 2025 | API Version: v1

Copyright © 2025 Engagifii