referenceData-geography belgianCities

Aperçu

Service qui permet de consulter la liste des communes belges disponibles dans les trois langues du pays

Vous voulez encoder une adresse belge, et vous voulez valider la commune et son code postal à partir d'un nom incomplet de la commune alors vous pouvez appeler l'API REST referenceData/geography, accessible librement depuis internet.

Description fonctionnelle

Le service REST referenceData/geography offre, pour la ressource belgianCities, les fonctionnalités suivantes :

• Obtenir une liste de toutes les communes belges, principales ou non-fusionnées
• Obtenir les communes belges, principales ou non-fusionnées, à partir d'un nom - partiel ou complet - de la commune
• Obtenir les communes belges, principales ou non-fusionnées, à partir du code postal officiel - partiel ou entier - de la commune
• Obtenir les communes belges, principales ou non-fusionnées, à partir du code postal officiel - partiel ou entier - et d'un nom de la commune - partielle ou entière
• Obtenir les communes belges, principales ou non-fusionnées, à partir du code région
• Obtenir les communes belges, principales ou non-fusionnées, à partir du code région linguistique
• Obtenir les communes belges, principales ou non-fusionnées, à partir du code INS d'une commune principale

Remarque: pour obtenir seulement les communes actives, il faudra préciser le paramètre date de fin de validité plus grand ou égal à la date du jour. Exemple: '?validityEndDate.gte=AAAAMMJJ '

Pour chaque commune belge, on peut avoir les informations suivantes :

• Code INS de la commune, s'il s'agit d'une commune principale
• Code postal belge officiel de la commune
• Nom de la commune, principale ou non-fusionnée, dans les trois langues, français (= FR), néerlandais (= NL) et allemand (= DE)
• Le régime linguistique de la commune F, FN, FD, N, NF, DF, FN_NF et NF_FN, où F = français, N = néerlandais, D = allemand, FN_NF et NF_FN = bilingue et FN, FD, NF, DF sont les communes à facilités linguistiques
• Le code région BRU (= Région de Bruxelles-Capitale), VLG (= Région flamande) et WAL (= Région wallone)
• Le code région linguistique FR, NL, DE, BIL (= bilingue)
• Date de début de validité
• Date de fin de validité
• Le lien de l'identifiant technique de la commune principale correspondante, si la commune n'est pas la commune principale
• Le lien de son identifiant technique

• certaines communes spéciales n'ont pas de code INS, p.ex. Bruxelles X, Bruxelles OTAN…
• à chaque commune non-fusionnée correspond une commune principale
• on peut réduire la liste aux communes principales avec le paramètre isMainCity=true

Description technique

API REST non sécurisée disponible sur internet.

Public cible

Toute application qui traite des adresses belges et qui nécessite un code postal, un code INS de la commune ou des dates de validité des communes belges.

Remarques :

• Dans le cadre du projet BElgian STreets address, les sources authentiques des adresses sont dorénavant gérées par les régions. Le SPF Stratégie et Appui (Bosa) met à disposition les services SOAP et REST pour la consultation des communes, rues et adresses.
• L'API REST referenceData/geography belgianCities est quant à elle basée sur les données issues du Registre National (et BCSS), où nous avons pu noter quelques données différentes avec la source authentique des adresses régionales. Dès que ces différences seront résorbées nous déprécierons cet API ci.
• L'API REST referenceData/geography belgianCities offre aussi les ressources 'countries' et 'belgianStreets', mais cette dernière ressource est dépréciée et n'est plus mise à jour depuis 28 mars 2021.

Conditions d'intégration

Le service n’étant pas sécurisé, il n’y a pas de conditions d’intégration particulières.

Cependant pour les applications Angular, il faudra transmettre l'URL de l'application afin de configurer son accès au service.

Documentation

• Bosa : documentation BEST address services
• Fichier Swagger
• Documentation fonctionnelle

Contact

Contact : ReuseOperational@smals.be