Documentation de l'API Izzydiag

Introduction

L'API Izzydiag a pour but de faciliter la récupération des données des missions réalisées par les diagnostiqueurs de notre plateforme.
Vous pourrez télécharger les rapports et avoir accès aux données des visites virtuelles.

Authentification

L'authentification à l'API Izzydiag est basée sur Laravel Sanctum. Pour accéder aux endpoints, il est nécessaire de créer un compte sur la plateforme et d'obtenir un jeton d'accès. Incluez ce jeton dans l'en-tête Authorization de chaque requête, sous la forme Bearer {token}.

Expiration du token

Les tokens ont une durée de vie limitée. Une fois qu'un token a expiré, vous recevrez une réponse 401 Unauthorised à toutes les requêtes utilisant ce token. Si cela se produit, vous devrez générer un nouveau token en utilisant à nouveau l'endpoint d'authentification.

Header

L'API renvoie des données au format JSON. Pour indiquer à l'API que vous attendez une réponse au format JSON, vous devez inclure l'entête Accept avec la valeur application/json dans vos requêtes HTTP.

Vous devez également inclure l'en-tête Authorization avec la valeur Bearer {token} dans toutes les requêtes.

Format des Réponses d'API

Chaque réponse de l'API Izzydiag sera renvoyée dans un format JSON standardisé. Le corps de chaque réponse comprendra les éléments suivants :

`status` : Une chaîne de caractères indiquant l'état de la réponse. Il peut prendre les valeurs "success", "warning" ou "error", selon le résultat de la requête.
`message` : Une chaîne de caractères décrivant plus en détail la réponse ou l'état de la requête. C'est généralement utilisé pour transmettre des messages d'erreur ou de succès détaillés.
`data` : Il s'agit des données renvoyées par la requête. Dans le cas d'une erreur ou d'un avertissement, cette clé peut être null.
`errors` : Il s'agit d'un objet qui n'est présent que dans le cas d'une réponse d'avertissement. Il contient des détails supplémentaires sur les erreurs rencontrées lors du traitement de la requête.

Routes

URL de Base et URL de Développement

L'API Izzydiag est accessible via deux environnements différents : l'environnement de production et l'environnement de développement.

L'environnement de production est destiné à l'utilisation réelle de l'API et est accessible à l'URL de base suivante : `https://izzydiag.com`
L'environnement de développement est destiné aux tests et au développement. Il s'agit d'un environnement séparé où les modifications et les tests n'affectent pas l'environnement de production. Il est accessible à l'URL suivante : `https://dev.izzydiag.com`

Url	Type	Description
/api/agence-immobiliere/connexion	POST	Se connecter à l'api.
/api/agence-immobiliere/deconnexion	POST	Se déconnecter de l'api.
/api/agence-immobiliere/commande/parcourir	GET	Récupérer la liste des commandes de l'agence immobilière.
/api/agence-immobiliere/commande/{commande_id}/voir	GET	Récupérer les détails d'une commande.
/api/agence-immobiliere/commande/rapport/{report_id}/telechargement	GET	Télécharger un rapport.
/api/agence-immobiliere/commande/visit-virtuel/{virtual_visit_photo_id}/telechargement	GET	Télécharger une image de visite virtuelle.
/api/agence-immobiliere/agent-immobilier/parcourir	GET	Récupérer la liste des agents immobiliers.
/api/agence-immobiliere/agent-immobilier/{real_estate_agent_id}/voir	GET	Récupérer les détails d'un agent immobilier.
/api/agence-immobiliere/agent-immobilier/{real_estate_agent_id}/enregistrer	POST	Enregistrer un agent immobilier.
/api/agence-immobiliere/agent-immobilier/{real_estate_agent_id}/modifier	PUT	Modifier un agent immobilier.
/api/agence-immobiliere/agent-immobilier/{real_estate_agent_id}/supprimer	DELETE	Supprimer un agent immobilier.

Il est important de noter que, bien que ces environnements soient séparés, ils partagent la même structure d'API. Les endpoints et les méthodes seront les mêmes dans les deux environnements. Cependant, les données renvoyées et les résultats des requêtes peuvent différer, car les environnements ont des bases de données séparées et peuvent avoir des versions différentes de l'API.

Assurez-vous toujours de tester vos intégrations dans l'environnement de développement avant de les déployer en production pour éviter des erreurs imprévues ou des problèmes potentiels

Connexion

Méthode : POST

Endpoint : /api/v1/agence-immobiliere/connexion

Paramètres :

email (string, requis) - L'adresse e-mail de l'agence immobilière.
password (string, requis) - Le mot de passe de l'agence immobilière.

Exemple de requête :

Réponse : Un message de succès et le jeton d'accès (api_token).

Codes de statut HTTP : 200 (OK), 422 (Erreur de validation)

JSON

Description des propriétés de la réponse JSON

Propriété	Description
api_token	Le jeton d'accès de l'agence immobilière. (Bearer Token)

Déconnexion

Méthode : POST

Endpoint : /api/v1/agence-immobiliere/deconnexion

Authentification : Bearer {token}.

Réponse : Un message de succès.

Codes de statut HTTP : 200 (OK), 401 (Non Autorisé)

Exemple de requête :

JSON

Parcourir les commandes

Méthode : GET

Endpoint : /api/v1/agence-immobiliere/commande/parcourir

Authentification : Bearer {token}.

Paramètres de requête pour les relations optionnelles :

page - Pour paginer les commandes.
reports - Pour inclure les rapports liés aux commandes.
virtual_visits - Pour inclure les visites virtuelles liées aux commandes.
diagnostics - Pour inclure les diagnostics liés aux commandes.

Exemple de requête :

Réponse : Une liste de commandes filtrées avec leurs détails et les relations optionnelles demandées.

Codes de statut HTTP : 200 (OK), 401 (Non Autorisé)

JSON

Description des propriétés de la réponse JSON

Propriété et filtre(s)	Description
id	l'identifiant unique de la commande.
created_at (eq, gt, gte, lt, lte)	la date de création de la commande.
purchase_order_number (eq)	le numéro de commande.
status (eq, gt, gte, lt, lte)	status Le champ "status" représente le statut de la commande. Il peut avoir les valeurs suivantes : `-1` : La commande a été annulée. `1` - En attente de validation `2` - La commande a été planifiée. `3` - La commande est terminée, les rapports sont disponibles. Pour filtrer les commandes en fonction de leur statut lors de l'appel à l'endpoint `/api/v1/agence-immobiliere/commande/parcourir`, vous pouvez utiliser le paramètre `status` dans la chaîne de requête, par exemple : `/api/v1/agence-immobiliere/commande/parcourir?status[eq]=3` pour obtenir toutes les commandes qui ont été réalisées.
payment_status (eq)	payment_status Le champ "payment_status" représente le statut de paiement de la commande. Il peut avoir les valeurs suivantes : `""` (chaîne vide) : Aucun paiement n'a encore été effectué ou enregistré pour la commande. `succeeded` - Le paiement a réussi. `failed` - Le paiement a échoué. `manual` - Le réglement de la commande ne s'effectue pas en ligne. Pour filtrer les commandes en fonction de leur statut de paiement lors de l'appel à l'endpoint `/api/v1/agence-immobiliere/commande/parcourir`, vous pouvez utiliser le paramètre `payment_status` dans la chaîne de requête, par exemple : `/api/v1/agence-immobiliere/commande/parcourir?payment_status[eq]=succeeded` pour obtenir toutes les commandes dont le paiement a réussi.
payment_date (eq, gt, gte, lt, lte)	la date de paiement de la commande.
intervention_date (eq, gt, gte, lt, lte)	la date d'intervention de la commande.
diagnostician_last_name (eq)	le nom du diagnostiqueur.
diagnostician_first_name (eq)	le prénom du diagnostiqueur.
diagnostician_cell_phone (eq)	le numéro de téléphone du diagnostiqueur.
diagnostician_email (eq)	l'adresse e-mail du diagnostiqueur.
floor	le numéro d'étage de la commande.
type_of_project (eq)	type_of_project Le champ "type_of_project" représente le type de projet associé à la commande. Il peut avoir les valeurs suivantes : `"sell"` : Vente - Le projet concerne la vente d'un bien immobilier. `"rent"` : Louer - Le projet concerne la location d'un bien immobilier. `"diagnostic"` : Diagnostics unitaires - Le projet concerne des diagnostics spécifiques à un bien immobilier. Pour filtrer les commandes en fonction de leur type de projet lors de l'appel à l'endpoint `/api/v1/agence-immobiliere/commande/parcourir`, vous pouvez utiliser le paramètre `type_of_project` dans la chaîne de requête, par exemple : `/api/v1/agence-immobiliere/commande/parcourir?area[eq]=rent` pour obtenir toutes les commandes qui concernent la location d'un bien immobilier.
type_of_building (eq)	type_of_building Le champ "type_of_building" représente le type de bien immobilier associé à la commande. Il peut avoir les valeurs suivantes : `"house"` : Maison `"apartment"` : Appartement `"local"` : Local commercial Pour filtrer les commandes en fonction de leur type de bien immobilier lors de l'appel à l'endpoint `/api/v1/agence-immobiliere/commande/parcourir`, vous pouvez utiliser le paramètre `type_of_building` dans la chaîne de requête, par exemple : `/api/v1/agence-immobiliere/commande/parcourir?type_of_building[eq]=house` pour obtenir toutes les commandes qui concernent une maison.
date_building (eq)	date_building Le champ "date_building" représente la date de construction du bien immobilier associé à la commande. Il peut avoir les valeurs suivantes : `"before_1949"` : Avant 1949 `"between_1949_and_1997"` : Entre 1949 et 1997 `"after_1997"` : Après 1997 `"unknown"` : Inconnue Pour filtrer les commandes en fonction de la date de construction du bien immobilier lors de l'appel à l'endpoint `/api/v1/agence-immobiliere/commande/parcourir`, vous pouvez utiliser le paramètre `date_building` dans la chaîne de requête, par exemple : `/api/v1/agence-immobiliere/commande/parcourir?date_building[eq]=before_1949` pour obtenir toutes les commandes qui concernent un bien immobilier construit avant 1949.
area (eq)	area Le champ "area" représente la surface en mètres carrés (m²) d'un bien immobilier. Il peut avoir les valeurs suivantes : `"-40"` : moins de 40 m². `"40-80"` : entre 40 m² et 80 m². `"80-120"` : entre 80 m² et 120 m². `"120-160"` : entre 120 m² et 160 m². `"160-200"` : entre 160 m² et 200 m². `"200-240"` : entre 200 m² et 240 m². `"+240"` : plus de 240 m². Pour filtrer les biens immobiliers en fonction de leur surface lors de l'appel à l'endpoint `/api/v1/agence-immobiliere/commande/parcourir`, vous pouvez utiliser le paramètre `area` dans la chaîne de requête, par exemple : `/api/v1/agence-immobiliere/commande/parcourir?area[eq]=40-80` pour obtenir tous les biens immobiliers ayant une surface entre 40 m² et 80 m².
gaz (eq)	gaz Le champ "gaz" représente le type d'installation gaz de la propriété. Il peut avoir les valeurs suivantes : `"gaz-15"` : Gaz - de 15 ans - L'installation gaz de la propriété a moins de 15 ans. `"gaz+15"` : Gaz + de 15 ans - L'installation gaz de la propriété a plus de 15 ans. `"none"` : Aucune - La propriété ne dispose pas d'installation gaz. `"unknown"` : Inconnue - Le type ou la présence d'installation gaz de la propriété est inconnu. Pour filtrer les commandes en fonction du type d'installation électrique de la propriété lors de l'appel à l'endpoint `/api/v1/agence-immobiliere/commande/parcourir`, vous pouvez utiliser le paramètre `gaz` dans la chaîne de requête, par exemple : `/api/v1/agence-immobiliere/commande/parcourir?gaz[eq]=gaz+15` pour obtenir toutes les commandes pour les propriétés qui ont une installation gaz de plus de 15 ans.
elec (eq)	elec Le champ "elec" représente le type d'installation électrique de la propriété. Il peut avoir les valeurs suivantes : `"elec-15"` : Elec - de 15 ans - L'installation électrique de la propriété a moins de 15 ans. `"elec+15"` : Elec + de 15 ans - L'installation électrique de la propriété a plus de 15 ans. `"none"` : Aucune - La propriété ne dispose pas d'installation électrique. `"unknown"` : Inconnue - Le type d'installation électrique de la propriété est inconnu. Pour filtrer les commandes en fonction du type d'installation électrique de la propriété lors de l'appel à l'endpoint `/api/v1/agence-immobiliere/commande/parcourir`, vous pouvez utiliser le paramètre `elec` dans la chaîne de requête, par exemple : `/api/v1/agence-immobiliere/commande/parcourir?elec[eq]=elec+15` pour obtenir toutes les commandes pour les propriétés qui ont une installation électrique de plus de 15 ans.
operating_address (eq)	L'adresse complète du bien.
operating_street_number (eq, gt, gte, lt, lte)	Le numéro de rue du bien.
operating_street_name (eq)	Le nom de rue du bien.
operating_postal_code (eq, gt, gte, lt, lte)	Le code postal du bien.
operating_city (eq)	La ville du bien.
operating_longitude (eq, gt, gte, lt, lte)	La longitude du bien.
operating_latitude (eq, gt, gte, lt, lte)	La latitude du bien.
client_first_name (eq)	Le prénom du client.
client_last_name (eq)	Le nom du client.
client_cell_phone (eq)	Le numéro de téléphone du client.
client_email (eq)	L'adresse e-mail du client.
client_billing_address (eq)	L'adresse complète de facturation du client.
additional_information	Les informations complémentaires de la commande.
person_present_first_name (eq)	Le prénom de la personne présente lors de l'intervention.
person_present_last_name (eq)	Le nom de la personne présente lors de l'intervention.
person_present_cell_phone (eq)	Le numéro de téléphone de la personne présente lors de l'intervention.
diagnostics	Un tableau des diagnostics réalisés.
reports	Un tableau des rapports déposés.
virtual_visits	Un tableau des visites virtuelles disponibles.

Objet `diagnostics`

Propriété	Description
name	Le nom du diagnostic.

Objet `reports`

Propriété	Description
url	L'URL pour télécharger le rapport.

Objet `virtual_visits`

Propriété	Description
url	L'URL de la visite virtuelle.
plateform	La plateforme sur laquelle la visite virtuelle est hébergée.
photos	Un tableau de photos de la visite virtuelle.

Objet `photos`

Propriété	Description
url	L'URL pour télécharger la photo.

Remarque :

Les lettres "eq", "gt" et "lt" signifient respectivement "égal à", "supérieur à" et "inférieur à".
Par exemple, pour filtrer les commandes avec un statut spécifique, la requête serait : `/api/v1/agence-immobiliere/commande/parcourir?status[eq]=votre_statut`
Pour inclure les rapports dans la réponse, ajoutez le paramètre de requête `reports` : `/api/v1/agence-immobiliere/commande/parcourir?reports=true`

Voir une commandes

Méthode : GET

Endpoint : /api/v1/agence-immobiliere/commande/{order_id}/voir

Authentification : Bearer {token}.

Remarque :

Les diagnostics, rapports, données de visite virtuelle sont inclues dans la réponse.

Exemple de requête :

Réponse : Si la requête est réussie, un code de statut HTTP 200 est renvoyé, avec un objet JSON représentant la commande demandée. Cet objet inclut également les rapports, les visites virtuelles et les diagnostics liés à cette commande.

Codes de statut HTTP : 200 (OK), 401 (Non Autorisé), 404 (Not Found) la commande demandée n'a pas été trouvée.

JSON

Télécharger un rapport

Méthode : GET

Endpoint : /api/v1/agence-immobiliere/commande/rapport/{report_id}/telechargement

Authentification : Bearer {token}.

Paramètres :

report (int, requis) - L'identifiant du rapport.

Exemple de requête :

Réponse : Le rapport de la commande en format PDF.

Codes de statut HTTP : 200 (OK), 401 (Non Autorisé), 403 (Commande non payée)

Télécharger une image de visite virtuelle

Méthode : GET

Endpoint : /api/v1/agence-immobiliere/commande/visit-virtuel/{virtual_visit_photo_id}/telechargement

Authentification : Bearer {token}.

Paramètres :

virtualVisitPhoto (int, requis) - L'identifiant de la photo de la visite virtuelle.

Exemple de requête :

Réponse : L'image de la visite virtuelle.

Codes de statut HTTP : 200 (OK), 401 (Non Autorisé), 403 (Commande non payée)

Parcourir les agents immobiliers

Méthode : GET

Endpoint : /api/v1/agence-immobiliere/agent-immobilier/parcourir

Authentification : Bearer {token}.

Paramètres de requête :

page - Pour paginer les agents immobilier.

Exemple de requête :

Réponse : Une liste de agents filtrées avec leurs détails.

Codes de statut HTTP : 200 (OK), 401 (Non Autorisé)

JSON

Description des propriétés de la réponse JSON

Propriété	Description
id	l'identifiant unique de l'agent immobilier.
created_at (eq)	La date de création de l'agent immobilier.
first_name (eq)	Le prénom de l'agent immobilier.
last_name (eq)	Le nom de l'agent immobilier.
phone (eq)	Le numéro de téléphone de l'agent immobilier.
email (eq)	L'adresse email de l'agent immobilier.
charges_enabled (eq)	Un booléen indiquant si l'agent immobilier a activé son compte Stripe pour recevoir les frais d'introduction.
promotional_code (eq)	Le code promotionnel de l'agent immobilier.

Remarque :

Les lettres "eq", "gt" et "lt" signifient respectivement "égal à", "supérieur à" et "inférieur à".
Par exemple, pour filtrer les commandes avec un statut spécifique, la requête serait : `/api/v1/agence-immobiliere/agent-immobilier/parcourir?last_name[eq]=nom`

Voir un agent immobiliers

Méthode : GET

Endpoint : /api/v1/agence-immobiliere/agent-immobilier/{real_estate_agent_id}/voir

Authentification : Bearer {token}.

Exemple de requête :

Réponse : Si la requête est réussie, un code de statut HTTP 200 est renvoyé, avec un objet JSON représentant l'agent immobilier demandé.

Codes de statut HTTP : 200 (OK), 401 (Non Autorisé)

JSON

Ajouter un agent immobilier

Important :

Un mail est envoyé à l'agent immobilier avec un lien pour qu'il puisse créer son propre mot de passe.

Méthode : POST

Endpoint : /api/v1/agence-immobiliere/agent-immobilier/enregistrer

Authentification : Bearer {token}.

Paramètres :

first_name (string, requis) - Prénom de l'agent immobilier.
last_name (string, requis) - Nom de l'agent immobilier.
phone (string, requis) - Numéro de téléphone de l'agent immobilier au format 10 chiffres.
email (string, requis) - Adresse email de l'agent immobilier.
password (string, optionnelle) - Mot de passe de l'agent immobilier. Doit contenir au moins une lettre majuscule, une lettre minuscule et un chiffre.

Remarque :

Les espaces dans le numéro de téléphone sont ignorés.
Le prénom est transformé en minuscules avec la première lettre en majuscule.
Le nom est transformé en majuscules.
Les accents du nom sont supprimés.

Exemple de requête :

Réponse : Détails de l'agent immobilier nouvellement créé.

Codes de statut HTTP : 200 (OK), 401 (Non Autorisé), 403 (Interdit)

Mettre à jour un agent immobilier

Méthode : PUT

Endpoint : /api/v1/agence-immobiliere/agent-immobilier/{real_estate_agent_id}/modifier

Authentification : Bearer {token}.

Paramètres :

first_name (string, optionnelle) - Prénom de l'agent immobilier.
last_name (string, optionnelle) - Nom de l'agent immobilier.
phone (string, optionnelle) - Numéro de téléphone de l'agent immobilier au format 10 chiffres.
email (string, optionnelle) - Adresse email de l'agent immobilier.
password (string, optionnelle) - Mot de passe de l'agent immobilier. Doit contenir au moins une lettre majuscule, une lettre minuscule et un chiffre.

Remarque :

Les espaces dans le numéro de téléphone sont ignorés.
Le prénom est transformé en minuscules avec la première lettre en majuscule.
Le nom est transformé en majuscules.
Les accents du nom sont supprimés.

Exemple de requête :

Réponse : Détails de l'agent immobilier nouvellement créé.

Codes de statut HTTP : 200 (OK), 401 (Non Autorisé), 403 (Interdit)

Exemple de réponse

Supprimer un agent immobilier

Important :

Tout agent supprimé ne pourra plus se connecter au site web.
Toutes ces données reste cependant dans la base de données.
Pour une suppression complète, veuillez contacter le support.

Méthode : DELETE

Endpoint : /api/v1/agence-immobiliere/agent-immobilier/{real_estate_agent_id}/supprimer

Authentification : Bearer {token}.

Réponse : Si la requête est réussie, un code de statut HTTP 200 est renvoyé, avec un message confirmant que l'agent immobilier est supprimé.

Codes de statut HTTP : 200 (OK), 401 (Non Autorisé), 403 (Interdit)

Exemple de requête :

Exemple de réponse