This is the developer index page.
Ce guide explique comment utiliser l'API que vous avez mise en place pour interagir avec les ressources de votre application. L'API permet aux utilisateurs d'effectuer diverses opérations, comme l'inscription, la connexion et la gestion des données.
L'API utilise le JSON Web Token (JWT) pour l'authentification. Les utilisateurs doivent s'authentifier pour accéder aux ressources protégées.
Flux d'authentification :
Inscription : /developer/new pour créer un nouveau compte.
Vous aurez une reponse comme quoi votre inscription a reussi dans le format json et ceci est à verifié dans la console du navigateur.
Connexion : /developer/connect avec ses informations d'identification. En cas de succès, un token JWT est renvoyé. Ce Token est unique et s'expire au bout d'une semaine à partir de la derniere connexion.
Le jeton est envoyé en format json et est à récupérer dans la console du navigateur.
Accès aux ressources protégées : Les utilisateurs doivent inclure le token JWT dans les en-têtes des requêtes pour accéder aux points de terminaison protégés.
Format de l'en-tête d'authentification
Authorization: Bearer
Ce guide explique comment utiliser l'API que vous avez mise en place pour interagir avec les ressources de votre application. L'API permet aux utilisateurs d'effectuer diverses opérations, comme l'inscription, la connexion et la gestion des données.
L'API retourne des codes d'état HTTP pour indiquer le résultat des opérations. Voici quelques erreurs courantes :
Lorsqu'on utilise la méthode POST, il y'a toujours des données à envoyer. Ces données doivent être forcément en json.
Point de terminaison de l'API
En-tête : Content-Type : application/json
Corps : en format json
Authorization: Bearer {token}"
Point de terminaison de l'API
Authorization: Bearer {token}"
| Route | Méthode HTTP | Nom de la Route | Description |
|---|---|---|---|
| /api/utilisateurs | GET | all_utilisateurs | Récupère tous les utilisateurs vérifiés |
| /api/utilisateurs/connexion | POST | connexion_utilisateurs | Connexion d'un utilisateur avec email et mot de passe |
| /api/utilisateurs/inscription | POST | inscription_utilisateurs | Inscription d'un nouvel utilisateur |
| /api/utilisateurs/update | POST | update_utilisateurs | Met à jour les informations d'un utilisateur |
| /api/utilisateurs/mdp_update | POST | mdp_update_utilisateurs | Met à jour le mot de passe d'un utilisateur |
| /api/utilisateurs/profil/{id} | GET | profil_utilisateurs | Récupère le profil d'un utilisateur par son ID |
| /api/utilisateurs/listValidate | GET | utilisateurs_non_valide | Récupère la liste des utilisateurs non validés |
| /api/utilisateurs/validate/{id} | PUT | utilisateurs_valide | Valide un utilisateur par son ID |
| /api/vehicule | GET | app_vehicule | Récupère tous les véhicules de la plateforme |
| /api/vehicule/utilisateur/{id} | GET | app_vehicule_utilisateur | Récupère tous les véhicules d'un utilisateur spécifique |
| /api/vehicule/utilisateur/add | POST | add_vehicule_utilisateur | Ajoute un nouveau véhicule à un utilisateur |
| /api/vehicule/utilisateur/update | POST | update_vehicule_utilisateur | Modifie les informations d'un véhicule existant |
| /api/vehicule/utilisateur/delete/{id} | DELETE | delete_vehicule_utilisateur | Supprime un véhicule par son ID |
| /api/evenement/register | POST | creation_evenements | Créer un nouvel événement |
| /api/evenement/update | POST | modification_evenements | Modifier un événement existant |
| /api/evenement/delete/{id} | DELETE | suppression_evenements | Supprimer un événement |
| /api/evenement/listValidate | GET | liste_valide_evenements | Liste des événements à valider |
| /api/evenement/verif/{id} | PUT | verification_evenements | Valider un événement |
| /api/evenement/deverif/{id} | PUT | deverification_evenements | Dévalider un événement |
| /api/evenement/event/{id} | GET | info_evenements | Obtenir les informations d'un événement par ID |
| /api/evenement/eventcat/{categorie} | GET | categorie_evenements | Obtenir les événements par catégorie |
| /api/evenement/search/{ville}/{categorie} | GET | categorie_evenements | Obtenir les événements par catégorie d'unne ville |
| /api/evenement/recherche/{ville} | GET | categorie_evenements | Obtenir les événements d'une ville ou commune |
| /api/evenement/eventcome | GET | venir_evenements | Liste des événements à venir |
| /api/evenement/eventpast | GET | passe_evenements | Liste des événements passés |
| /api/evenement/eventusercome/{id} | GET | user_venir_evenements | Événements à venir créés par un utilisateur |
| /api/evenement/eventuserpast/{id} | GET | user_past_evenements | Événements passés créés par un utilisateur |
| /api/evenement/listValidate/{keywords} | GET | recherche_evenements | Rechercher des événements par mot-clé |
| /api/adherer/register | POST | register_adherer | Inscription à un évènement |
| /api/adherer/unsuscribe/{idEvenement}/{idUtilisateur} | DELETE | unsuscribe_adherer | Désinscription d'un évènement |
| /api/adherer/utilisateur/{id} | GET | utilisateur_adherer | Évènements à venir de l'utilisateur inscrit |
| /api/adherer/pastuser/{id} | GET | pastuser_adherer | Évènements passés de l'utilisateur inscrit |
| /api/categorie/evenements | GET | app_categorie_evenements | Liste toutes les catégories d'événements |
| /api/categorie/event/{id} | GET | event_categorie_evenements | Affiche une catégorie par son ID |
| /api/categorie/add | POST | add_categorie_evenements | Ajoute une nouvelle catégorie d'événements |
| /api/categorie/event/update | POST | update_categorie_evenements | Modifie une catégorie existante |
| /api/covoiturage/event/{id} | GET | app_covoiturage | Récupère tous les covoiturages liés à un événement spécifique |
| /api/covoiturage/user/{id} | GET | user_covoiturage | Récupère tous les covoiturages proposés par un utilisateur |
| /api/covoiturage/add | POST | add_covoiturage | Créer un nouveau covoiturage |
| /api/covoiturage/update | POST | update_covoiturage | Met à jour les informations d'un covoiturage existant |
| /api/covoiturage/delete/{id} | DELETE | delete_covoiturage | Supprime un covoiturage par son ID |
| /api/covoiturage/eventreduc/{id} | PUT | reduc_place_covoiturage | Réduit le nombre de places disponibles dans un covoiturage |
| /api/covoiturage/eventajout/{id} | PUT | ajout_place_covoiturage | Augmente le nombre de places disponibles dans un covoiturage |
| /api/inscrire/add | app_inscrire | POST | Inscription d'un utilisateur à un covoiturage |
| /api/inscrire/unsubscribe/{idCovoiturage}/{idUtilisateur} | app_desinscrire | DELETE | Désinscription d'un utilisateur d'un covoiturage |
| /api/inscrire/usercome/{id} | app_covoit_come | GET | Liste des covoiturages à venir auxquels l'utilisateur est inscrit |
| /api/inscrire/userpast/{id} | app_covoit_past | GET | Liste des covoiturages passés auxquels l'utilisateur est inscrit |
| les variables à utilisés pour manipuler les données d'un utilisateur | ||
|---|---|---|
| Variable | Utilisation | Route |
| Adresse e-mail de l'utilisateur. Utilisée pour la connexion et l'inscription. | connexion_utilisateurs, inscription_utilisateurs | |
| mdp | Mot de passe de l'utilisateur. Utilisé pour la connexion et la mise à jour du mot de passe. | connexion_utilisateurs, inscription_utilisateurs, mdp_update_utilisateurs |
| nom | Nom de l'utilisateur. Utilisé lors de l'inscription et de la mise à jour des informations. | inscription_utilisateurs, update_utilisateurs |
| prenom | Prénom de l'utilisateur. Utilisé lors de l'inscription et de la mise à jour des informations. | inscription_utilisateurs, update_utilisateurs |
| telephone | Numéro de téléphone de l'utilisateur. Utilisé lors de l'inscription. | inscription_utilisateurs |
| ville | Ville de l'utilisateur. Utilisée lors de l'inscription et de la mise à jour des informations. | inscription_utilisateurs, update_utilisateurs |
| commune | Commune de l'utilisateur. Utilisée lors de l'inscription et de la mise à jour des informations. | inscription_utilisateurs, update_utilisateurs |
| avatar | URL ou chemin de l'avatar de l'utilisateur. Utilisé lors de l'inscription et de la mise à jour. | inscription_utilisateurs, update_utilisateurs |
| role | Rôle de l'utilisateur. Utilisé lors de l'inscription pour définir le rôle de l'utilisateur. | inscription_utilisateurs |
| id | ID de l'utilisateur. Utilisé pour identifier un utilisateur lors des mises à jour et de la récupération du profil. | update_utilisateurs, mdp_update_utilisateurs, profil_utilisateurs, utilisateurs_valide |
| les variables à utilisés pour manipuler les données concernant les véhicules d'utilisateurs | ||
|---|---|---|
| Variable | Utilisation | Route |
| utilisateur | ID de l'utilisateur à qui le véhicule appartient. Utilisé lors de l'ajout d'un véhicule. | add_vehicule_utilisateur |
| marque | ID de la marque du véhicule. Utilisé lors de l'ajout d'un véhicule. | add_vehicule_utilisateur |
| type | ID du type de véhicule. Utilisé lors de l'ajout d'un véhicule. | add_vehicule_utilisateur |
| libelle | Libellé du véhicule. Utilisé lors de l'ajout et de la modification d'un véhicule. | add_vehicule_utilisateur, update_vehicule_utilisateur |
| immatriculation | Numéro d'immatriculation du véhicule. Utilisé lors de l'ajout et de la modification d'un véhicule. | add_vehicule_utilisateur, update_vehicule_utilisateur |
| place | Nombre de places dans le véhicule. Utilisé lors de l'ajout d'un véhicule. | add_vehicule_utilisateur |
| id | ID du véhicule. Utilisé pour identifier un véhicule lors de la mise à jour et de la suppression. | update_vehicule_utilisateur, delete_vehicule |
| les variables à utilisés pour manipuler les données concernant les évenements | ||
|---|---|---|
| Variable | Utilisation | Nom de la Route |
| DateEvent | Date de l'événement. | ajouter un événement |
| HeureEvent | Heure de l'événement. | ajouter un événement |
| place | Nombre de places disponibles pour l'événement. | ajouter un événement |
| min | Prix minimum des billets de l'événement. | ajouter un événement, modifier un événement |
| max | Prix maximum des billets de l'événement. | ajouter un événement, modifier un événement |
| utilisateur | ID de l'utilisateur qui crée/modifie l'événement. | ajouter un événement |
| categorie | ID de la catégorie de l'événement. | ajouter un événement |
| Titre | Titre de l'événement. | ajouter un événement |
| ville | Ville où se déroule l'événement. | ajouter un événement |
| commune | Commune où se déroule l'événement. | ajouter un événement |
| adresse | Adresse précise de l'événement. | ajouter un événement |
| dCourte | Description courte de l'événement. | ajouter un événement, modifier un événement |
| dLongue | Description longue de l'événement. | ajouter un événement, modifier un événement |
| lienBillet | Lien vers la billetterie de l'événement. | ajouter un événement, modifier un événement |
| nom | Nom de la structure organisatrice de l'événement. | ajouter un événement |
| visiteur | Nombre de visiteurs prévus pour l'événement. | ajouter un événement |
| cover | Image evenement. | ajouter un événement, modifier un évènement |
| id | ID de l'événement pour la mise à jour ou la suppression. | modifier un événement, supprimer un événement, modifier un événement |
| keywords | Mots-clés pour la recherche d'événements. | |
| categorie | nom categorie pour la recherche d'événements. |
| les variables à utilisés pour manipuler les données concernant les covoiturages | ||
|---|---|---|
| Variable | Utilisation | Nom de la Route |
| id | ID de l'événement pour récupérer les covoiturages associés. | app_covoiturage (GET) |
| id | ID de l'utilisateur pour récupérer les covoiturages proposés par cet utilisateur. | user_covoiturage (GET) |
| idEvenement | ID de l'événement pour lequel un covoiturage est créé. | add_covoiturage (POST) |
| idUtilisateur | ID de l'utilisateur qui propose le covoiturage. | add_covoiturage (POST) |
| idVoiture | ID du véhicule utilisé pour le covoiturage. | add_covoiturage (POST) |
| heure | Heure de départ du covoiturage. | add_covoiturage (POST), update_covoiturage (POST) |
| montant | Montant unitaire par passager pour le covoiturage. | add_covoiturage (POST), update_covoiturage (POST) |
| nbPlace | Nombre de places disponibles pour le covoiturage. | add_covoiturage (POST), reduc_place_covoiturage (PUT), ajout_place_covoiturage (PUT) |
| depart | Lieu de départ du covoiturage. | add_covoiturage (POST), update_covoiturage (POST) |
| commune | Commune de départ du covoiturage. | add_covoiturage (POST), update_covoiturage (POST) |
| descriptif | Description du covoiturage. | add_covoiturage (POST), update_covoiturage (POST) |
| contact | Contact du conducteur pour le covoiturage. | add_covoiturage (POST), update_covoiturage (POST) |
| id | ID du covoiturage à modifier ou à supprimer. | update_covoiturage (POST), delete_covoiturage (DELETE) |
| les variables à utilisés pour manipuler les données concernant les catégories évenements | ||
|---|---|---|
| Variable | Utilisation | Nom de la Route |
| Aucune | Récupère toutes les catégories d'événements. | app_categorie_evenements (GET) |
| id | ID de la catégorie d'événements pour récupérer les informations associées. | event_categorie_evenements (GET) |
| categorie | Nom de la catégorie d'événements à ajouter. | add_categorie_evenements (POST) |
| couleur | Couleur de la catégorie d'événements à ajouter. | add_categorie_evenements (POST) |
| id | ID de la catégorie d'événements à modifier. | update_categorie_evenements (POST) |
| couleur | Nouvelle couleur à attribuer à la catégorie d'événements à modifier. | update_categorie_evenements (POST) |
| les variables à utilisés pour manipuler les données concernant l'inscription a un évènement | ||
|---|---|---|
| Variable | Utilisation | Nom de la Route |
| idEvenement, idUtilisateur | Inscription d'un utilisateur à un événement. | register_adherer (POST) |
| idEvenement, idUtilisateur | Désinscription d'un utilisateur d'un événement. | unsuscribe_adherer (DELETE) |
| id | ID utilisateur pour Liste des événements à venir auxquels l'utilisateur est inscrit. | utilisateur_adherer (GET) |
| id | ID utilisateur pour Liste des événements passés auxquels l'utilisateur est inscrit. | pastuser_adherer (GET) |
| les variables à utilisés pour manipuler les données concernant l'inscription a un covoiturage | ||
|---|---|---|
| Variable | Utilisation | Nom de la Route |
| idCovoiturage, idUtilisateur | Inscription d'un utilisateur à un covoiturage. | app_inscrire (POST) |
| idCovoiturage, idUtilisateur | Désinscription d'un utilisateur d'un covoiturage. | app_desinscrire (DELETE) |
| id | ID utilisateur pour Liste des covoiturages à venir auxquels l'utilisateur est inscrit. | app_covoit_come (GET) |
| id | ID utilisateur pour Liste des covoiturages passés auxquels l'utilisateur est inscrit. | app_covoit_past (GET) |
const data = {
username: "exampleUser",
password: "examplePassword"
};
fetch('http://localhost:8000/api/login', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer <your-token>'
},
body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => {
console.log('Success:', data);
})
.catch((error) => {
console.error('Error:', error);
});
fetch('http://localhost:8000/api/users', {
method: 'GET',
headers: {
'Authorization': 'Bearer <your-token>'
}
})
.then(response => response.json())
.then(data => {
console.log('Success:', data);
})
.catch((error) => {
console.error('Error:', error);
});
<?php
$url = 'http://localhost:8000/api/login';
$data = array(
'username' => 'exampleUser',
'password' => 'examplePassword'
);
$options = array(
'http' => array(
'header' => "Content-Type: application/json\r\n" .
"Authorization: Bearer <your-token>\r\n",
'method' => 'POST',
'content' => json_encode($data),
),
);
$context = stream_context_create($options);
$result = file_get_contents($url, false, $context);
if ($result === FALSE) {
// Handle error
}
var_dump($result);
?>
<?php
$url = 'http://localhost:8000/api/users';
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Authorization: Bearer <your-token>'
));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
if($response === FALSE){
echo "cURL Error: " . curl_error($ch);
}
curl_close($ch);
echo $response;
?>