apiRushscholl / README.md
Liantsoaxx08's picture
Initial deployment
a03ac57
|
Raw
History Blame Contribute Delete
1.29 kB
---
title: API Admission Rush School
emoji: 🚀
colorFrom: blue
colorTo: purple
sdk: docker
pinned: false
license: apache-2.0
---
# API Admission Rush School
API FastAPI pour gérer les documents d'admission des étudiants.
## Fonctionnalités
- Gestion des candidatures
- Upload de documents (CV, CIN, lettre de motivation, etc.)
- Intégration avec Airtable
- Validation des données
## Documentation API
Une fois déployée, la documentation interactive sera disponible à :
- `/docs` - Documentation Swagger UI
- `/redoc` - Documentation ReDoc
## Variables d'environnement requises
⚠️ **Important** : Vous devez configurer les variables d'environnement suivantes dans les Settings de votre Space :
```
AIRTABLE_API_KEY=votre_clé_api
AIRTABLE_BASE_ID=votre_base_id
AIRTABLE_TABLE_NAME=votre_table_name
DEBUG=false
```
## Utilisation
L'API sera accessible via l'URL fournie par Hugging Face Spaces.
Endpoints principaux :
- `GET /` - Page d'accueil
- `GET /api/v1/health` - Vérification de santé
- `POST /api/v1/admission/upload-documents` - Upload de documents
- `GET /api/v1/admission/{record_id}` - Récupération d'une candidature
## Développement local
```bash
pip install -r requirements.txt
python app.py
```
L'API sera disponible sur http://localhost:7860