Overview
The Mapademics API provides programmatic access to your organization’s academic data, enabling you to integrate course information, skills analysis, and job matching capabilities into existing systems like Student Information Systems (SIS), Learning Management Systems (LMS), or custom applications.The Mapademics API uses RESTful principles with JSON requests and responses. All endpoints require proper authentication and are organization-scoped for data security.
Getting Started
Base URL
All API requests should be made to:Authentication Methods
Mapademics supports two primary authentication methods depending on your use case:Used for public-facing integrations like embeddable widgets where data needs to be accessible without user sessions.Use Cases:
- Embeddable program widgets
- Public course catalogs
- Career pathway displays
Getting Your API Credentials
1
Locate Your Organization API Key
Your Public API Key is automatically generated when your organization is created. Contact your Mapademics administrator or support team to retrieve it.
Public API keys follow the format:
pk_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
2
Set up Authentication Headers
For session-based authentication, you’ll need to implement OAuth or session management with your existing authentication system.
Never expose API keys in client-side code. Use server-side proxy endpoints for secure API access.
Available API Endpoints
Academic Data Endpoints
Programs
Courses
Courses with Sections
Instructors
Job Market Data Endpoints
Custom Jobs
Widget Integration Endpoints
Program Widget Data
Your organization’s public API key starting with
pk_
The unique identifier for the program you want widget data for
Authentication Implementation
Public API Key Authentication
Use this method for widget integrations and public-facing features:Session-Based Authentication
For internal system integration, implement session management:Data Schemas
Core Data Models
Program Schema
Unique identifier for the program (format:
prog_xxxxxxxxx
)Display name of the academic program
Detailed description of the program
Internal program code used by the institution
Classification of Instructional Programs (CIP) code for federal reporting
Array of course IDs defining the recommended sequence
Skills Schema
Array of extracted skills from course content or job descriptions
Error Handling
HTTP Status Codes
The Mapademics API uses standard HTTP status codes to indicate success or failure:Success Codes (2xx)
Success Codes (2xx)
- 200 OK - Request succeeded
- 201 Created - Resource created successfully
- 204 No Content - Request succeeded with no response body
Client Error Codes (4xx)
Client Error Codes (4xx)
- 400 Bad Request - Invalid request parameters
- 401 Unauthorized - Invalid or missing authentication
- 403 Forbidden - Valid authentication but insufficient permissions
- 404 Not Found - Resource not found
- 429 Too Many Requests - Rate limit exceeded
Server Error Codes (5xx)
Server Error Codes (5xx)
- 500 Internal Server Error - Unexpected server error
- 502 Bad Gateway - Service temporarily unavailable
- 503 Service Unavailable - Service maintenance
Error Response Format
All API errors return a consistent JSON structure:Rate Limiting
The Mapademics API implements rate limiting to ensure fair usage and system stability.
Rate Limit Details
- Public API (Widget): 1000 requests per hour per API key
- Private API (Session-based): 5000 requests per hour per organization
- Bulk Operations: 100 requests per hour per organization
Rate Limit Headers
All API responses include rate limiting information in headers:Handling Rate Limits
Integration Examples
Student Information System (SIS) Integration
Synchronize program and course data with your SIS:Career Services Dashboard
Create a career outcomes dashboard using widget data:Security Best Practices
Following security best practices is crucial when integrating with the Mapademics API to protect sensitive academic data.
API Key Security
1
Server-Side Storage
Store API keys securely on your server, never in client-side code or version control.
Environment Variables
2
Key Rotation
Implement a key rotation strategy and monitor API key usage for suspicious activity.
Contact support to rotate compromised API keys immediately.
3
Access Control
Limit API access to specific IP addresses or network ranges when possible.
Data Handling
- Encryption in Transit: All API communication uses HTTPS/TLS encryption
- Data Minimization: Only request and store data necessary for your use case
- Access Logging: Log all API requests for security auditing
- Data Retention: Implement appropriate data retention policies
Troubleshooting
Common Issues
401 Unauthorized - Invalid API Key
401 Unauthorized - Invalid API Key
404 Not Found - Resource Not Found
404 Not Found - Resource Not Found
Symptoms: Requests to specific resources return 404 statusSolutions:
- Verify the resource ID exists in your organization
- Check that the resource hasn’t been soft-deleted
- Ensure you have permission to access the resource
- Verify the API endpoint URL is correct
429 Too Many Requests - Rate Limited
429 Too Many Requests - Rate Limited
Symptoms: Requests return 429 status after heavy usageSolutions:
- Implement exponential backoff retry logic
- Cache responses to reduce API calls
- Use bulk endpoints where available
- Contact support if you need higher rate limits
CORS Issues - Widget Integration
CORS Issues - Widget Integration
Symptoms: Browser blocks widget API requests due to CORS policySolutions:
- Use the widget API endpoints which include proper CORS headers
- Implement a server-side proxy for private API endpoints
- Verify your domain is allowlisted for widget access
- Use proper authentication methods for your integration type
Support & Resources
Getting Help
- Documentation Issues: Report errors or request additions via your support channel
- API Questions: Contact technical support with specific endpoint and use case details
- Integration Assistance: Schedule consultation calls for complex integration projects
- Feature Requests: Submit requests through your customer success manager
Additional Resources
Bulk Data Import
Learn about importing large datasets via Excel/CSV files as an alternative to API integration.
Widget Integration
Explore embeddable widgets for displaying career outcomes on external websites.
Data Model Reference
Understand the complete data structure and relationships in Mapademics.
Authentication Setup
Learn more about user authentication and session management.
The Mapademics API is actively developed with new endpoints and features added regularly. Subscribe to API updates through your account settings to stay informed of changes.