Créer des API

Deux API REST sont disponibles dans le module Build :

  • Service de gestion des constructions
  • Service de validation de la construction

Service de validation de la construction (REST)

Le service de validation permet de configurer des règles de validation pour contrôler le contenu lors d'une importation. Ces règles de validation peuvent être appliquées à un ou plusieurs modèles d'importation, de manière à ce que vous ayez un contrôle total sur la validation à appliquer à chaque importation. Cette fonction est généralement réservée au propriétaire du réseau, en tant que propriétaire et décideur du réseau.

Swagger La documentation de l'API Swagger est disponible à l'adresse suivante https://validation.build.gridsz.com/swagger/

Service de gestion des constructions (REST)

Grâce au service de gestion, vous pourrez fournir des mises à jour à des entités spécifiques au sein du module de construction. Il s'agit par exemple de mises à jour concernant une zone commerciale ou un PoP. En outre, vous pouvez récupérer toutes les informations pertinentes sur les entités pour vos propres besoins de données.

Les utilisateurs de BUILD ont la possibilité de gérer les bâtiments à l'aide des API de gestion des bâtiments, notamment :

  • Récupérer un bâtiment existant à l'aide de l'identifiant de bâtiment
  • Récupérer plusieurs bâtiments
    • en utilisant les identifiants externes des bâtiments (généralement pand_id)
    • en fournissant des identifiants d'adresses
  • Récupérer toutes les adresses appartenant à un bâtiment à l'aide de l'identifiant du bâtiment
  • Créer un nouveau bâtiment
  • Mise à jour d'un bâtiment existant par ID de bâtiment
  • Mise à jour des adresses d'un bâtiment existant par ID de bâtiment
  • Supprimer un bâtiment existant en
    • ID du bâtiment
    • ID externe du bâtiment

Swagger La documentation de l'API Swagger est disponible à l'adresse suivante https://management.build.gridsz.com/swagger/

Vous pouvez trouver tous les exemples de demandes et de réponses de l'API dans les spécifications. Prenons l'exemple de l'API Créer un nouveau bâtiment. L'exemple de demande est accessible ci-dessous, et l'exemple de réponse suit.