Skip to content

ArtichautDev/Cabanga-API-DOCS-Reverse-engineering

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Documentation API Cabanga - NON OFFICIEL

Ce depot contient une documentation technique de l API Cabanga/Scolares, construite a partir de captures HAR anonymisees. Cabanga est conbstruit sur une infrastructure ou le frontend fait constamment des requetes API au back-end, ces requetes sont ecrites en clair, ce qui rends tres facile d'utiliser les services de cabanga, et surement plus largement Scolares, sans passer par leur interface, evitant ainsi les bugs/defauts de leur frontend... Cela peut etre utile pour de l'importation de masse vers Cabanga par exemple, fonctionnalité très mal supporté par Cabanga pour le moment. Le seul enjeux est de passer la phase de récupération des tokens, soit vous extrayez les votres depuis votre navigateur, soit vous construiser un petit user agent ou vous resolvez vous meme le captcha pour passer le keycloack d'authentification.

Objectif

  • Documenter tous les endpoints observes dans les captures reseau.
  • Donner des exemples de requetes et de reponses lisibles.
  • Fournir une base collaborative pour completer les routes manquantes.

Methodologie

  • Source principale: 3 fichiers HAR nettoyes.
  • Deduplication par methode + URL normalisee.
  • Anonymisation stricte des donnees sensibles.
  • Troncature des grandes listes pour garder la doc exploitable.

Contenu du depot

  • docs/01_AUTH.md: Authentification (Keycloak, token)
  • docs/02_CORE.md: Profils, ecole, parametres
  • docs/03_ACADEMIC.md: Journal, evaluations, attributions
  • docs/04_ATTENDANCE.md: Discipline et assiduite
  • docs/05_PARENTS.md: Bulletins, routes parent
  • docs/06_CALENDAR.md: Activites, conges, horaires
  • docs/07_OTHER.md: Routes annexes
  • docs/99_ENDPOINT_INDEX.md: Index complet de tous les endpoints
  • docs/generation_summary.json: Resume de la generation

Etat actuel

  • Endpoints uniques documentes: 32
  • Couverture index -> docs: 100%
  • Donnees personnelles: anonymisees

Contribution

Les contributions sont bienvenues pour:

  • Ajouter des reponses manquantes quand le HAR ne contient pas de body
  • Affiner les schemas de reponse
  • Ajouter de nouveaux endpoints issus de nouvelles captures

Voir CONTRIBUTING.md pour le processus.

Avertissement

Ce travail est non officiel et base sur de l observation technique. Les structures peuvent evoluer avec les versions de l application et du backend.

Disclaimer non officiel

  • Ce depot n est pas un produit officiel Cabanga/Scolares.
  • Ce depot n est pas affilie, approuve, sponsorise ou maintenu par Cabanga/Scolares.
  • Les marques, noms de produit et logos restent la propriete de leurs proprietaires respectifs.

Cadre legal et usage responsable

  • Cette documentation decrit des endpoints observes dans des captures reseau (HAR) anonymisees.
  • Ne publiez ni token, ni cookies de session, ni donnees personnelles.
  • Respectez toujours les conditions d utilisation du service, les droits applicables et la reglementation locale.

About

Documentation non officielle publique pour l'api de CABANGA (Scolares)

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages