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.
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}.
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.
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 avec la valeur
dans vos requêtes HTTP.
Vous devez également inclure l'en-tête avec la valeur dans toutes les requêtes.
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 :
L'API Izzydiag est accessible via deux environnements différents : l'environnement de production et l'environnement de développement.
Url | Type | Description |
---|---|---|
/api/agence-immobiliere/connexion | Se connecter à l'api. | |
/api/agence-immobiliere/deconnexion | Se déconnecter de l'api. | |
/api/agence-immobiliere/commande/parcourir | Récupérer la liste des commandes de l'agence immobilière. | |
/api/agence-immobiliere/commande//voir | Récupérer les détails d'une commande. | |
/api/agence-immobiliere/commande/rapport//telechargement | Télécharger un rapport. | |
/api/agence-immobiliere/commande/visit-virtuel//telechargement | Télécharger une image de visite virtuelle. | |
/api/agence-immobiliere/agent-immobilier/parcourir | Récupérer la liste des agents immobiliers. | |
/api/agence-immobiliere/agent-immobilier//voir | Récupérer les détails d'un agent immobilier. | |
/api/agence-immobiliere/agent-immobilier//enregistrer | Enregistrer un agent immobilier. | |
/api/agence-immobiliere/agent-immobilier//modifier | Modifier un agent immobilier. | |
/api/agence-immobiliere/agent-immobilier//supprimer | 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
Propriété | Description |
---|---|
api_token | Le jeton d'accès de l'agence immobilière. (Bearer Token) |
Propriété et filtre(s) | Description |
---|---|
id | l'identifiant unique de la commande. |
created_at |
la date de création de la commande. |
purchase_order_number |
le numéro de commande. |
status |
status
Le champ "status" représente le statut de la commande. Il peut avoir les valeurs suivantes :
Pour filtrer les commandes en fonction de leur statut lors de
l'appel à l'endpoint |
payment_status |
payment_status
Le champ "payment_status" représente le statut de paiement de la commande. Il peut avoir les valeurs suivantes :
Pour filtrer les commandes en fonction de leur statut de paiement
lors de l'appel à l'endpoint |
payment_date |
la date de paiement de la commande. |
intervention_date |
la date d'intervention de la commande. |
diagnostician_last_name |
le nom du diagnostiqueur. |
diagnostician_first_name |
le prénom du diagnostiqueur. |
diagnostician_cell_phone |
le numéro de téléphone du diagnostiqueur. |
diagnostician_email |
l'adresse e-mail du diagnostiqueur. |
floor | le numéro d'étage de la commande. |
type_of_project |
type_of_project
Le champ "type_of_project" représente le type de projet associé à la commande. Il peut avoir les valeurs suivantes :
Pour filtrer les commandes en fonction de leur type de projet lors
de l'appel à l'endpoint |
type_of_building |
type_of_building
Le champ "type_of_building" représente le type de bien immobilier associé à la commande. Il peut avoir les valeurs suivantes :
Pour filtrer les commandes en fonction de leur type de bien
immobilier lors de l'appel à l'endpoint |
date_building |
date_building
Le champ "date_building" représente la date de construction du bien immobilier associé à la commande. Il peut avoir les valeurs suivantes :
Pour filtrer les commandes en fonction de la date de construction du
bien immobilier lors de l'appel à l'endpoint |
area
|
area
Le champ "area" représente la surface en mètres carrés (m²) d'un bien immobilier. Il peut avoir les valeurs suivantes :
Pour filtrer les biens immobiliers en fonction de leur surface lors
de l'appel à l'endpoint |
gaz |
gaz
Le champ "gaz" représente le type d'installation gaz de la propriété. Il peut avoir les valeurs suivantes :
Pour filtrer les commandes en fonction du type d'installation
électrique de la propriété lors de
l'appel à l'endpoint |
elec |
elec
Le champ "elec" représente le type d'installation électrique de la propriété. Il peut avoir les valeurs suivantes :
Pour filtrer les commandes en fonction du type d'installation électrique de la propriété
lors de
l'appel à l'endpoint |
operating_address |
L'adresse complète du bien. |
operating_street_number |
Le numéro de rue du bien. |
operating_street_name |
Le nom de rue du bien. |
operating_postal_code |
Le code postal du bien. |
operating_city |
La ville du bien. |
operating_longitude |
La longitude du bien. |
operating_latitude |
La latitude du bien. |
client_first_name |
Le prénom du client. |
client_last_name |
Le nom du client. |
client_cell_phone |
Le numéro de téléphone du client. |
client_email |
L'adresse e-mail du client. |
client_billing_address |
L'adresse complète de facturation du client. |
additional_information | Les informations complémentaires de la commande. |
person_present_first_name |
Le prénom de la personne présente lors de l'intervention. |
person_present_last_name |
Le nom de la personne présente lors de l'intervention. |
person_present_cell_phone |
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. |
Propriété | Description |
---|---|
name | Le nom du diagnostic. |
Propriété | Description |
---|---|
url | L'URL pour télécharger le rapport. |
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. |
Propriété | Description |
---|---|
url | L'URL pour télécharger la photo. |
Propriété | Description |
---|---|
id | l'identifiant unique de l'agent immobilier. |
created_at |
La date de création de l'agent immobilier. |
first_name |
Le prénom de l'agent immobilier. |
last_name |
Le nom de l'agent immobilier. |
phone |
Le numéro de téléphone de l'agent immobilier. |
email |
L'adresse email de l'agent immobilier. |
charges_enabled |
Un booléen indiquant si l'agent immobilier a activé son compte Stripe pour recevoir les frais d'introduction. |
promotional_code |
Le code promotionnel de l'agent immobilier. |
Un mail est envoyé à l'agent immobilier avec un lien pour qu'il puisse créer son propre mot de passe.
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.