🧒 KidsSpot API

Une API RESTful permettant d'accéder à des informations sur des lieux et événements adaptés aux enfants.

📋 Sommaire

Description
Prérequis
Installation
Configuration
Structure du projet
Points d'accès API
Authentification
Documentation technique
Contribuer
Licence

📝 Description

KidsSpot API est un service web qui permet aux développeurs et aux applications d'accéder à une base de données de lieux et d'événements adaptés aux enfants. L'API fournit des informations détaillées sur ces lieux, notamment leur emplacement, leurs équipements, ainsi que les commentaires et évaluations des utilisateurs.

🔧 Prérequis

PHP 8.0 ou supérieur
MySQL 5.7 ou supérieur
Serveur web (Apache/Nginx)

🏗️ Installation

1. Récupération du code source

git clone https://github.com/Seb-Prod/api_kidsSpot.git
cd api_kidsSpot

2. Configuration de la base de données

Créez la base de données :

Vous devez d'abord créer la base de données dans votre serveur MySQL avant d'importer les données. Vous pouvez le faire en utilisant un client MySQL (comme phpMyAdmin, MySQL Workbench, ou la ligne de commande).

Par exemple, avec la ligne de commande MySQL :

mysql -u votre_nom_utilisateur -p
# Vous serez invité à entrer votre mot de passe
mysql> CREATE DATABASE IF NOT EXISTS `kids_spot`; 
mysql> USE `kids_spot`;

Importez le fichier kids_spot.sql :
Une fois la base de données créée et sélectionnée, importez le fichier SQL pour créer les tables et insérer les données.

mysql> SOURCE /sql/kids_spot.sql

(Remplacez /sql/kids_spot.sql par le chemin réel du fichier.)

⚙️ Configuration

Cette API utilise des fichiers .env pour gérer les variables d'environnement.

Fichiers `.env`

L'application utilise les fichiers .env suivants pour la configuration :

.env.local : Configuration spécifique à votre environnement de développement local. Ce fichier surcharge les configurations du .env principal.
.env.production : Configuration pour l'environnement de production.
.env.example : Un fichier modèle contenant toutes les variables d'environnement nécessaires avec des valeurs par défaut ou des espaces réservés. Vous devez copier ce fichier vers .env.local et .env.production et y configurer les valeurs appropriées.

Configuration de la base de données

Configurez les variables d'environnement : Copiez le contenu du fichier .env.example vers .env.local (pour votre développement local) et .env.production (pour votre environnement de production). Ensuite, modifiez ces fichiers avec les informations de configuration appropriées pour chaque environnement.

Exemple de configuration dans .env.local :
```
APP_ENV=development

# Base de données
DB_HOST=localhost
DB_NAME=kids_spot
DB_USER=root
DB_PASSWORD=

# JWT
JWT_SECRET=votre_clé_secrète_pour_jwt

# Configuration Email
MAIL_HOST=smtp.gmail.com
MAIL_AUTH=true
MAIL_USERNAME=kidspottp@gmail.com
MAIL_PASSWORD=zcnw vpsy yobn ayis
MAIL_SECURE=tls
MAIL_PORT=587
MAIL_FROM_EMAIL=kidspottp@gmail.com
MAIL_FROM_NAME="Kids Spot"
```
Assurez-vous de configurer correctement les informations de connexion à la base de données, la clé secrète JWT et les paramètres d'email dans les fichiers .env.local et .env.production.

Déploiement

Pour un environnement de développement local:
- Placez le projet dans le dossier htdocs (XAMPP) ou www (WAMP/MAMP)
- Démarrez Apache et MySQL
- Accédez à l'API via http://localhost/api_kidsSpot/
Pour un environnement de production:
- Déployez les fichiers sur votre serveur web
- Assurez-vous que les permissions des fichiers sont correctement configurées
- Configurez votre serveur web pour pointer sur le répertoire racine du projet

Sécurité

La clé secrète JWT (JWT_SECRET) doit être une chaîne aléatoire complexe pour assurer la sécurité des tokens
En production, assurez-vous que les fichiers de configuration ne sont pas accessibles publiquement
Utilisez HTTPS pour protéger les communications API

CORS

Si vous devez configurer les CORS pour permettre l'accès depuis d'autres domaines, modifiez le fichier .htaccess ou ajoutez les en-têtes appropriés dans vos scripts PHP.

📂 Structure du projet

Le projet est organisé par logique métier, chaque dossier correspond à un module spécifique de l'API.

📦api_kidsSpot/
┣ 📂 commentaires/          # Contient les endpoints pour les commentaires.
┣ 📂 config/                # Contient les fichiers de configuration de l'application et la connexion à la base de données.
┣ 📂 documentation/         # Documentation technique détaillée par endpoint.
┣ 📂 errors/                # Contient les pages d'erreurs personnalisées pour certaines situations.
┣ 📂 favoris/               # Contient les endpoints pour les favoris.
┣ 📂 lib/                   # Librairies et fonctions utilitaires.
┣ 📂 lieux/                 # Contient les endpoints pour les lieux.
┣ 📂 middleware/            # Contient les classes d'aide pour la validation, la sécurité, les autorisations et le formatage des données.
┣ 📂 models/                # Contient les classes PHP représentant les tables de la base de données.
┣ 📂 profil/                # Contient les endpoints pour les préférences utilisateur.
┣ 📂 sql/                   # Contient les fichiers SQL nécessaires à la création de la base de données.
┗ 📂 users/                 # Contient les endpoints pour les utilisateurs.

ℹ️ Information

Grades utilisateurs

ID	Valeur
1	standard
2	superUser
3	spare
4	admin

Types de lieux

ID	Valeur
1	Restaurant
2	Loisir
3	Culture

Types d'équipement

ID	Valeur
1	Accès poussette
2	Aire de jeux
3	Micro-ondes
4	Chaise haute
5	Table à langer
6	Parking

🌐 Points d'accès API

Lieux

Endpoint	Méthode	Description	🔐	📖
`/lieux/{id}`	GET	Détails d'un lieu spécifique	Non	📖
`/lieux/autour/{lat}/{long}`	GET	Liste les lieux autour d'une position	Non	📖
`/lieux/ajout`	POST	Ajoute un nouveau lieu/événement	Oui	📖
`/lieux/modifier`	PUT	Modifie un lieu/événement existant	Oui	📖
`/lieux/supprimer`	DELETE	Supprime un lieu/événement	Oui	📖

Commentaires

Endpoint	Méthode	Description	🔐	📖
`/commentaires/{id}`	GET	Détails d'un commentaire	Non	📖
`/commentaires/lieu/{id}`	GET	Liste les commentaires d'un lieu	Non	📖
`/commentaires/ajouter`	POST	Ajoute un commentaire	Oui	📖
`/commentaires/modifier`	PUT	Modifie un commentaire	Oui	📖
`/commentaires/supprimer`	DELETE	Supprime un commentaire	Oui	📖

Favoris

Endpoint	Méthode	Description	🔐	📖
`/favoris/ajouter`	POST	Ajoute un favori	Oui	📖
`/favoris/{lat}/{lng}`	GET	Liste tous les favoris	Oui	📖
`/favoris/supprimer`	DELETE	Supprime un favori	Oui	📖

User

Endpoint	Méthode	Description	🔐	📖
`/users/create.php`	POST	Ajoute un utilisateur	Non	📖
`/users/forgot.php`	POST	Envoie un mail avec un token de récupération	Non	📖
`/users/login.php`	POST	Authentification des utilisateurs	Non	📖
`/users/reset.php`	POST	Réinitialisation du mot de passe via un token	Non	📖
`/users/sendMail.php`	POST	Envoi d'emails groupés aux utilisateurs	Oui	📖
`/users/update.php`	PUT	Mise à jour du profil utilisateur	Oui	📖

Profil (préférences de l'utilisateur)

Endpoint	Méthode	Description	🔐	📖
`/profil/editer`	POST	Editer les préférences de l'utilisateur	Oui	📖
`/profil/`	GET	Liste les préférences de l'utilisateur	Oui	📖

🔐 Authentification

L'API utilise l'authentification par token JWT (JSON Web Token). Pour les endpoints protégés:

Obtenez un token via /users/login.php avec vos identifiants
Utilisez ce token dans l'en-tête HTTP pour les requêtes authentifiées:
```
Authorization: Bearer votre_token_jwt
```

Le token a une durée de validité limitée et devra être renouvelé périodiquement.

📚 Documentation technique

Models

Model	📖
Commentaires.php	📖

Classes

Classe	📖
/middleware/Validator.php	📖
/middleware/FormatHelper.php	📖

Fonctions

Fonctions	📖
/middleware/UserAutorisation.php	📖
/middleware/ResponseHelper.php	📖
/middleware/Mailer.php	📖

Autres documentation

🤝 Contribuer

Les contributions sont les bienvenues! Pour contribuer:

Forkez le projet
Créez une branche pour votre fonctionnalité (git checkout -b feature/ma-fonctionnalite)
Committez vos changements (git commit -m 'Ajout de ma fonctionnalité')
Poussez vers la branche (git push origin feature/ma-fonctionnalite)
Ouvrez une Pull Request

📄 Licence

Ce projet est sous licence MIT. Voir le fichier LICENSE pour plus de détails.

Name		Name	Last commit message	Last commit date
Latest commit History 77 Commits
commentaires		commentaires
config		config
documentation		documentation
errors		errors
favoris		favoris
lib/PHPMailer		lib/PHPMailer
lieux		lieux
middleware		middleware
models		models
profil		profil
sql		sql
tests		tests
users		users
.env.example		.env.example
.gitignore		.gitignore
README.md		README.md
index.php		index.php

Seb-Prod/api_kidsSpot

Folders and files

Latest commit

History

Repository files navigation

🧒 KidsSpot API

📋 Sommaire

📝 Description

🔧 Prérequis

🏗️ Installation

1. Récupération du code source

2. Configuration de la base de données

Créez la base de données :

Importez le fichier kids_spot.sql :

⚙️ Configuration

Fichiers .env

Configuration de la base de données

Déploiement

Sécurité

CORS

📂 Structure du projet

ℹ️ Information

Grades utilisateurs

Types de lieux

Types d'équipement

🌐 Points d'accès API

Lieux

Commentaires

Favoris

User

Profil (préférences de l'utilisateur)

🔐 Authentification

📚 Documentation technique

Models

Classes

Fonctions

Autres documentation

🤝 Contribuer

📄 Licence

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Importez le fichier `kids_spot.sql` :

Fichiers `.env`

Packages