Skip to main content

API Overview

Introduction​

This Python-powered FastAPI web service provides a robust interface to the YetiForce CRM system, offering comprehensive functionality for user management and feedback collection.

Key Endpoints​

User Authentication​

  • GET /getUser: Retrieves detailed user information
  • GET /trylogUser: Attempts user login verification

Feedback Management​

Feedback Creation Endpoints​

  • POST /createFeedbackFamily: Submit host family feedback
  • POST /createFeedbackPlacement: Record job placement experience
  • POST /createFeedbackErasmus: Log Erasmus program feedback
  • POST /createFeedbackHybrid: Capture hybrid learning experiences

Feedback Verification Endpoints​

  • GET /check_family_feedback: Check existing family feedback
  • GET /check_placement_feedback: Verify placement feedback status
  • GET /check_erasmus_feedback: Confirm Erasmus feedback submission
  • GET /check_hybrid_feedback: Validate hybrid feedback record

Technical Features​

  • CORS Support: Enables cross-origin resource sharing
  • Custom Logging: Implements detailed, color-coded logging
  • YetiForce Integration: Leverages yetiforcewrapper for seamless CRM interaction

Prerequisites​

Python Requirements

To effectively use and understand this API, you should have:

  • Basic Python programming knowledge
  • Familiarity with FastAPI
  • Understanding of RESTful API concepts

Additional Information​

Architectural Note

This middleman API serves as an intermediary layer between client applications and the YetiForce CRM, providing a structured, secure method for data exchange and feedback management.