This guide will walk you through integrating EducUp’s API to bring accredited courses into your system. This integration allows you to fetch course data based on state, department, board, and specialty filters and display them for purchase. Additionally, you can track signups and sales using EducUp’s affiliate tools.
Step 1: API Overview
The EducUp API provides an endpoint for retrieving accredited courses:
GET /api/v1/accredited/courses
Query Parameters:
- stateid: The ID of the state to fetch courses for.
- departmentid: The ID of the department (e.g., Healthcare, Education).
- boardid: The ID of the board or governing body for the courses.
- specialityid: The ID of the specialty or subject area.
Refer to the EducUp API Swagger Documentation: https://externalapi.educup.io/index.html for detailed parameter descriptions.
Step 2: Example Request
To demonstrate how to fetch accredited courses, here’s an example request for Florida CHCBMs:
Response Example: [ { "courseId": "12345", "title": "Introduction to CHCBMs", "description": "This course provides foundational knowledge on CBHCM practices.", "hours": 3, "price": 49.99, "state": "Florida", "department": "Healthcare", "board": "CBHCM Board", "speciality": "CBHCM", "provider": "EducUp", "affiliateLink": "https://educup.io/courses/12345?inviterId=yourEducUperId" } ]
Step 3: Display the Courses in Your System
Once you fetch the courses, you can display them using the response data. The basic structure includes:
- Course Title
- Description
- Hours
- Price
- State, Department, Board, and Specialty
- Affiliate Link
Use the affiliate link to direct users to purchase courses and ensure tracking of signups and sales.
Step 4: Track Sales and Signups
EducUp allows you to track signups and purchases through the Affiliate section in EducUp Studio. Ensure you append your affiliateId to the affiliate link provided in the API response.
Example Affiliate Link:
https://educup.io/courses/12345?inviterId=yourEducUperId
Accessing Affiliate Reports:
- Log in to EducUp Studio: https://educup.io/studio.
- Navigate to the Affiliate section.
- View detailed reports on signups, purchases, and commissions.
Step 5: Test the Integration
To ensure everything works as expected:
- Use the Swagger Documentation: https://externalapi.educup.io/index.html to test API requests.
- Verify the course data is correctly displayed on your platform.
- Check that signups and purchases are tracked in the Affiliate dashboard.
Conclusion
Integrating EducUp’s API is a simple way to expand your course offerings while earning affiliate revenue. For any questions or assistance, feel free to contact EducUp Support.
Happy integrating! 🎉