# 📚 Documentation API mcV3 - Index

## Bienvenue! 👋

Vous trouverez ici la documentation complète pour utiliser l'API de mcV3.

---

## 📖 Commencer par ici

### 🚀 [GUIDE_USER_RAPIDE_API.md](./GUIDE_USER_RAPIDE_API.md)
**Durée: 5 minutes**

Guide de démarrage rapide pour commencer immédiatement:
- ✅ Créer une clé API
- ✅ Accéder à l'API
- ✅ Exemples pratiques
- ✅ Gestion des erreurs courants

**Pour:** Utilisateurs pressés qui veulent tester rapidement

---

## 📚 [DOCUMENTATION_API.md](./DOCUMENTATION_API.md)
**Durée: 30 minutes pour lecture complète**

Documentation complète et détaillée couvrant:
- 🏗️ Architecture générale du système
- 🔐 Tous les détails d'authentification
- 📡 Documentation de chaque endpoint API
- 🔑 Gestion des clés API
- 👥 Rôles et permissions
- 📊 Codes HTTP et gestion d'erreurs
- 🔧 Intégrations (JS, Python, PHP)
- ⚙️ Configuration avancée
- ❓ FAQ et dépannage

**Pour:** Développeurs qui veulent comprendre le système en détail

---

## 🎯 Accès rapide par sujet

### Authentification
- [Guide rapide - Section 2](./GUIDE_USER_RAPIDE_API.md#2️⃣-accéder-à-laapi)
- [Détaillé - Authentification](./DOCUMENTATION_API.md#authentification)

### Endpoints API
- [Guide rapide - Section 3](./GUIDE_USER_RAPIDE_API.md#3️⃣-endpoints-disponibles)
- [Détaillé - Endpoints API](./DOCUMENTATION_API.md#endpoints-api)

### Gestion des clés
- [Guide rapide - Section 1](./GUIDE_USER_RAPIDE_API.md#1️⃣-créer-une-clé-api)
- [Détaillé - Gestion des clés API](./DOCUMENTATION_API.md#gestion-des-clés-api)

### Rôles et permissions
- [Détaillé - Rôles et permissions](./DOCUMENTATION_API.md#rôles-et-permissions)

### Erreurs et dépannage
- [Guide rapide - Section 6](./GUIDE_USER_RAPIDE_API.md#6️⃣-gestion-des-erreurs-courants)
- [Détaillé - Codes HTTP](./DOCUMENTATION_API.md#codes-http-et-erreurs)
- [Détaillé - FAQ](./DOCUMENTATION_API.md#faq-et-dépannage)

### Intégrations
- [Guide rapide - Section 5](./GUIDE_USER_RAPIDE_API.md#5️⃣-utilisation-dans-votre-application)
- [Détaillé - Intégrations](./DOCUMENTATION_API.md#intégrations)

---

## 💡 Parcours d'apprentissage

### Niveau 1: Utilisateur final (15 min)
1. Lire [GUIDE_USER_RAPIDE_API.md](./GUIDE_USER_RAPIDE_API.md) sections 1-3
2. Créer une clé API
3. Tester un endpoint

### Niveau 2: Développeur frontend (1 heure)
1. Lire [GUIDE_USER_RAPIDE_API.md](./GUIDE_USER_RAPIDE_API.md) en entier
2. Lire [DOCUMENTATION_API.md](./DOCUMENTATION_API.md) sections Authentification + Endpoints
3. Implémenter l'intégration dans votre framework
4. Tester les erreurs courants

### Niveau 3: Développeur backend (2 heures)
1. Lire [DOCUMENTATION_API.md](./DOCUMENTATION_API.md) en entier
2. Comprendre l'architecture complète
3. Ajouter des endpoints personnalisés
4. Implémenter la gestion d'erreurs avancée

### Niveau 4: Administrateur (30 min)
1. Lire [DOCUMENTATION_API.md](./DOCUMENTATION_API.md) section Configuration avancée
2. Configurer HTTPS en production
3. Mettre en place le monitoring

---

## 🆘 Besoin d'aide rapide?

### "Je veux créer une clé API"
→ [GUIDE_USER_RAPIDE_API.md - Section 1](./GUIDE_USER_RAPIDE_API.md#1️⃣-créer-une-clé-api)

### "Ça ne fonctionne pas"
→ [DOCUMENTATION_API.md - FAQ](./DOCUMENTATION_API.md#faq-et-dépannage)

### "Je veux intégrer l'API à mon app"
→ [DOCUMENTATION_API.md - Intégrations](./DOCUMENTATION_API.md#intégrations)

### "Qu'est-ce qu'une clé API?"
→ [DOCUMENTATION_API.md - Authentification](./DOCUMENTATION_API.md#mode-1-bearer-token-clé-api)

### "J'ai une erreur 401"
→ [DOCUMENTATION_API.md - Codes HTTP](./DOCUMENTATION_API.md#401-unauthorized)

### "Quels endpoints sont disponibles?"
→ [DOCUMENTATION_API.md - Endpoints API](./DOCUMENTATION_API.md#endpoints-api)

---

## 📋 Checklist - Avant d'aller en production

- [ ] Lire la documentation complète
- [ ] Créer une clé API de test
- [ ] Tester tous les endpoints
- [ ] Implémenter la gestion d'erreurs
- [ ] Activer HTTPS
- [ ] Configurer CORS si nécessaire
- [ ] Mettre en place le monitoring
- [ ] Documenter vos endpoints personnalisés

---

## 🚀 Commandes utiles

```bash
# Créer une clé API
php bin/console app:api-key:create pseudo_utilisateur "Nom"

# Lister les routes API
php bin/console debug:router | grep api

# Voir les logs
tail -f var/log/dev.log

# Vider le cache
php bin/console cache:clear
```

---

## 📞 Support

Pour toutes les questions:
1. Vérifier la [FAQ](./DOCUMENTATION_API.md#faq-et-dépannage)
2. Consulter la [section dépannage](./DOCUMENTATION_API.md#faq-et-dépannage)
3. Vérifier les [codes d'erreur](./DOCUMENTATION_API.md#codes-http-et-erreurs)

---

**Dernière mise à jour: 2026-04-03**

