Guides d’utilisation et d’administration
Les ressources sont classées selon la tâche : utiliser un écran, configurer un module ou relier un système à l’API. Les guides présentent les prérequis, les étapes et les vérifications à effectuer.
Intégration de l’API
Pour les équipes TI et les intégrateurs : authentification par clé, groupes de ressources, réponses d’erreur et limites de requêtes. OpenAPI désigne le contrat lisible par les outils de développement.
Consulter la référence technique →Guides par tâche
Pour les employés et les administrateurs municipaux : repérer un écran, préparer les renseignements requis, effectuer une configuration et vérifier le résultat.
Accéder aux guides produit →Pour les équipes TI
Préparation d’une intégration
L’API REST utilise des adresses HTTP et retourne du JSON. L’intégration commence par l’obtention de la clé associée à la ville; celle-ci est transmise dans l’en-tête X-API-Key, puis les ressources autorisées sont testées. Le contrat OpenAPI décrit les paramètres et les schémas.
Points d’accès · extraits
v1La plupart des ressources sont consultées en lecture. Les opérations d’écriture présentées concernent les organismes. Vérifier les accès →
Comprendre une nouvelle version
Les notes de version indiquent les écrans et les rôles touchés.