1 line
15 KiB
JSON
1 line
15 KiB
JSON
{"spec":{"openapi":"3.0.0","info":{"title":"API d'Atmo Data, l'agr\u00e9gateur des flux open data des AASQA","description":"Service d'acc\u00e8s aux flux Geojson et CSV des donn\u00e9es produites par les Associations agr\u00e9\u00e9es de surveillance de la qualit\u00e9 de l\u2019air - T\u00e9l\u00e9charger la \u003Ca href='https://www.atmo-france.org/sites/federation/files/medias/documents/2023-04/FAQ_API_Atmo_Data_20230412.pdf'\u003EFAQ\u003C/a\u003E pour une bonne utilisation de l'API\u003Cbr /\u003E\u003Cbr /\u003EL'acc\u00e8s aux donn\u00e9es requiert l'autorisation d'un d'administrateur de l'application. Vous pouvez r\u00e9aliser une demande de cr\u00e9ation de compte \u00e0 \u003Ca href='/inscription-api' \u003Ecette adresse\u003C/a\u003E.\u003Cbr /\u003E\u003Cbr /\u003E Pour vous connecter, vous devez ins\u00e9rer votre token via le bouton \u00ab Authorize \u00bb\u003Cbr /\u003E\u003Cbr /\u003E \u003Cu\u003EListe des AASQA (code \u00e0 renseigner) :\u003C/u\u003E\u003Cbr /\u003E Guadeloupe (01) / Martinique (02) / Guyane (03) / La R\u00e9union (04) / Mayotte (06) / \u00cele-de-France (11) / Centre-Val de Loire (24) / Bourgogne-Franche-Comt\u00e9 (27) / Normandie (28)\u003Cbr /\u003E Hauts-de-France (32) / Grand Est (44) / Pays de la Loire (52) / Bretagne (53) / Nouvelle-Aquitaine (75) / Occitanie (76) / Auvergne-Rh\u00f4ne-Alpes (84) / Provence-Alpes-C\u00f4te d'Azur (93) / Corse (94)","version":"2.0.0"},"paths":{"/api/login":{"post":{"tags":["Connexion"],"summary":"R\u00e9cup\u00e9ration d'un Token JWT, n\u00e9cessaire pour utiliser l'API","description":"Le token a une dur\u00e9e de validit\u00e9 de 24 heures","requestBody":{"description":"Identifiants de connexion","required":true,"content":{"application/json":{"schema":{"required":["userName"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}}},"responses":{"default":{"description":""}}}},"/api/v2/data/indices/atmo":{"get":{"tags":["Indice de qualit\u00e9 de l'air"],"summary":"R\u00e9cup\u00e9ration des indices ATMO","description":"\u003Ca target='_blank' href='https://www.atmo-france.org/sites/federation/files/medias/documents/2022-04/guide_calcul_nouvel_indice_ATMO_VF_version14decembre2020.pdf'\u003ELien vers la documentation technique des indices ATMO\u003C/a\u003E","operationId":"get_indices_atmo","parameters":[{"name":"format","in":"query","description":"S\u00e9lection du format de sortie","required":false,"schema":{"type":"string","default":"geojson","enum":["geojson","csv"]}},{"name":"date","in":"query","description":"S\u00e9lection de la date","required":false,"schema":{"type":"string","format":"YYYY-MM-DD","example":"2024-06-08"}},{"name":"date_historique","in":"query","description":"S\u00e9lection des donn\u00e9es de la p\u00e9riode entre date_historique et date","required":false,"schema":{"type":"string","format":"YYYY-MM-DD","example":"2024-06-08"}},{"name":"code_zone","in":"query","description":"S\u00e9lection d'un ou plusieurs territoires par leur code INSEE (commune / EPCI), tous par d\u00e9faut","required":false,"schema":{"type":"string"}},{"name":"aasqa","in":"query","description":"S\u00e9lection d'une ou plusieurs AASQA fournissant la donn\u00e9e, toutes par d\u00e9faut","required":false,"schema":{"type":"string","enum":["01","02","03","04","06","11","24","27","28","32","44","52","53","75","76","84","93","94"]}},{"name":"code_qualificatif","in":"query","description":"S\u00e9lection par valeur d'indice ATMO (0: Absent, 1: Bon, 2: Moyen, 3: D\u00e9grad\u00e9, 4: Mauvais, 5: Tr\u00e8s mauvais, 6: Extr\u00eamement mauvais, 7: Ev\u00e9nement) , tous par d\u00e9faut ","required":false,"schema":{"description":"0 \u00e0 7 (Du meilleurs au plus mauvais)","type":"string","enum":["0","1","2","3","4","5","6","7"]}},{"name":"bounding_box","in":"query","description":"S\u00e9lection d\u2019un territoire d\u00e9fini par une bounding box","required":false,"schema":{"type":"string","format":"xmin ymin xmax ymax"}},{"name":"bounding_box_srs","in":"query","description":"EPSG de la bounding box, 4326 par d\u00e9faut","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Retourne les indices ATMO.\u003Cbr /\u003E\u003Cbr /\u003E\u003Ca target='_blank' href='/exemple_indices.json'\u003EExemple de r\u00e9ponse\u003C/a\u003E"}}}},"/api/v2/data/episodes/3jours":{"get":{"tags":["Episodes de pollution"],"summary":"Donn\u00e9es des \u00e9pisodes de pollutions en cours sur 3 jours (J-1, J0, J+1)","description":"\u003Ca target='_blank' href='https://www.atmo-france.org/article/les-episodes-de-pollution'\u003ELien vers la documentation\u003C/a\u003E\u003Cbr /\u003E\u003Cbr /\u003E\u003Cu\u003EPour la r\u00e9gion Auvergne-Rh\u00f4ne-Alpes, liste des bassins d'air (code_zone \u00e0 renseigner) :\u003C/u\u003E Bassin Grenoblois (2000) / Bassin L\u00e9manique (2001) / Bassin St\u00e9phanois (2002) / Bassin Lyon Nord-Is\u00e8re (2003) / Contreforts Massif Central (2004) / Est Dr\u00f4me (2005) / Ouest Ain (2006) / Ouest Ard\u00e8che (2007) / Vall\u00e9e de l'Arve (2008) / Vall\u00e9e du Rh\u00f4ne (2009) / Vall\u00e9e Maurienne Tarentaise (2010) / Zone des Coteaux (2011)","operationId":"get_episodes_actuel_atmo","parameters":[{"name":"format","in":"query","description":"S\u00e9lection du format de sortie","required":false,"schema":{"type":"string","default":"geojson","enum":["geojson","csv"]}},{"name":"aasqa","in":"query","description":"S\u00e9lection d'une ou plusieurs AASQA fournissant la donn\u00e9e, toutes par d\u00e9faut","required":false,"schema":{"type":"string","enum":["01","02","03","04","06","11","24","27","28","32","44","52","53","75","76","84","93","94"]}},{"name":"code_zone","in":"query","description":"S\u00e9lection d'un ou plusieurs territoires par leur code INSEE (d\u00e9partements ou bassins d'air), tous par d\u00e9faut","required":false,"schema":{"type":"string"}},{"name":"polluant","in":"query","description":"S\u00e9lection d'un polluant, tous par d\u00e9faut","required":false,"schema":{"type":"string","enum":["NO2","SO2","PM10","PM2.5","O3"]}},{"name":"type_episode","in":"query","description":"S\u00e9lection d'un type d'\u00e9pisode, tous par d\u00e9faut","required":false,"schema":{"type":"string","enum":["PAS DE DEPASSEMENT","INFORMATION ET RECOMMANDATION","ALERTE SUR PERSISTANCE","ALERTE"]}},{"name":"echeance","in":"query","description":"S\u00e9lection de J-1 (hier), J0 (aujourd'hui), J+1 (demain), tous par d\u00e9faut","required":false,"schema":{"type":"string","enum":["-1","0","1"]}},{"name":"bounding_box","in":"query","description":"S\u00e9lection d\u2019un territoire d\u00e9fini par une bounding box","required":false,"schema":{"type":"string","format":"xmin ymin xmax ymax"}},{"name":"bounding_box_srs","in":"query","description":"EPSG de la bounding box, 4326 par d\u00e9faut","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Retourne les \u00e9pisodes ATMO.\u003Cbr /\u003E\u003Cbr /\u003E\u003Ca target='_blank' href='/exemple_episodes.json'\u003EExemple de r\u00e9ponse\u003C/a\u003E"}}}},"/api/v2/data/episodes/historique":{"get":{"tags":["Episodes de pollution"],"summary":"Donn\u00e9es des \u00e9pisodes de pollution constat\u00e9s sur l'ann\u00e9e pass\u00e9e","description":"\u003Ca target='_blank' href='https://www.atmo-france.org/article/les-episodes-de-pollution'\u003ELien vers la documentation\u003C/a\u003E\u003Cbr /\u003E\u003Cbr /\u003E\u003Cu\u003EPour la r\u00e9gion Auvergne-Rh\u00f4ne-Alpes, liste des bassins d'air (code_zone \u00e0 renseigner) :\u003C/u\u003E Bassin Grenoblois (2000) / Bassin L\u00e9manique (2001) / Bassin St\u00e9phanois (2002) / Bassin Lyon Nord-Is\u00e8re (2003) / Contreforts Massif Central (2004) / Est Dr\u00f4me (2005) / Ouest Ain (2006) / Ouest Ard\u00e8che (2007) / Vall\u00e9e de l'Arve (2008) / Vall\u00e9e du Rh\u00f4ne (2009) / Vall\u00e9e Maurienne Tarentaise (2010) / Zone des Coteaux (2011)","operationId":"get_episodes_historique_atmo","parameters":[{"name":"format","in":"query","description":"S\u00e9lection du format de sortie","required":false,"schema":{"type":"string","default":"geojson","enum":["geojson","csv"]}},{"name":"aasqa","in":"query","description":"S\u00e9lection d'une ou plusieurs AASQA fournissant la donn\u00e9e, toutes par d\u00e9faut","required":false,"schema":{"type":"string","enum":["01","02","03","04","06","11","24","27","28","32","44","52","53","75","76","84","93","94"]}},{"name":"code_zone","in":"query","description":"S\u00e9lection d'un ou plusieurs territoires par leur code INSEE (d\u00e9partements ou bassins d'air), tous par d\u00e9faut","required":false,"schema":{"type":"string"}},{"name":"polluant","in":"query","description":"S\u00e9lection d'un polluant, tous par d\u00e9faut","required":false,"schema":{"type":"string","enum":["NO2","SO2","PM10","PM2.5","O3"]}},{"name":"type_episode","in":"query","description":"S\u00e9lection d'un type d'\u00e9pisode, tous par d\u00e9faut","required":false,"schema":{"type":"string","enum":["PAS DE DEPASSEMENT","INFORMATION ET RECOMMANDATION","ALERTE SUR PERSISTANCE","ALERTE"]}},{"name":"date","in":"query","description":"S\u00e9lection d'une date","required":true,"schema":{"type":"string","format":"YYYY-MM-DD"}},{"name":"date_historique","in":"query","description":"S\u00e9lection des donn\u00e9es de la p\u00e9riode entre date_historique et date","required":false,"schema":{"type":"string","format":"YYYY-MM-DD"}},{"name":"bounding_box","in":"query","description":"S\u00e9lection d\u2019un territoire d\u00e9fini par une bounding box","required":false,"schema":{"type":"string","format":"xmin ymin xmax ymax"}},{"name":"bounding_box_srs","in":"query","description":"EPSG de la bounding box, 4326 par d\u00e9faut","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Retourne les \u00e9pisodes ATMO.\u003Cbr /\u003E\u003Cbr /\u003E\u003Ca target='_blank' href='/exemple_episodes.json'\u003EExemple de r\u00e9ponse\u003C/a\u003E"}}}},"/api/v2/data/inventaires/emissions":{"get":{"tags":["Inventaires"],"summary":"Donn\u00e9es issues des inventaires des \u00e9missions","description":"\u003Cu\u003EListe des secteurs (code \u00e0 renseigner) :\u003C/u\u003E Agriculture (5) / Transport routier (6) / Autres transports (7) / R\u00e9sidentiel - Tertiaire (34) / Industrie, branche \u00e9nergie, d\u00e9chets (219)","operationId":"get_emissions_atmo","parameters":[{"name":"format","in":"query","description":"S\u00e9lection du format de sortie","required":false,"schema":{"type":"string","default":"geojson","enum":["geojson","csv"]}},{"name":"echelle","in":"query","description":"S\u00e9lection de l'\u00e9chelle d'agr\u00e9gation des donn\u00e9es","required":false,"schema":{"type":"string","default":"region","enum":["region","epci"]}},{"name":"code_zone","in":"query","description":"S\u00e9lection d'un ou plusieurs territoire(s) par son code zone (EPCI uniquement), tous par d\u00e9faut","required":false,"schema":{"type":"string"}},{"name":"aasqa","in":"query","description":"S\u00e9lection d'une ou plusieurs AASQA fournissant la donn\u00e9e, toutes par d\u00e9faut","required":false,"schema":{"type":"string","enum":["01","02","03","04","06","11","24","27","28","32","44","52","53","75","76","84","93","94"]}},{"name":"secteur","in":"query","description":"S\u00e9lection d'un ou plusieurs grand secteur, tous par d\u00e9faut. Le d\u00e9coupage sectoriel n'est disponible qu'\u00e0 l'\u00e9chelle r\u00e9gionale.","required":false,"schema":{"type":"string"}},{"name":"bounding_box","in":"query","description":"S\u00e9lection d\u2019un territoire d\u00e9fini par une bounding box","required":false,"schema":{"type":"string","format":"xmin ymin xmax ymax"}},{"name":"bounding_box_srs","in":"query","description":"EPSG de la bounding box, 4326 par d\u00e9faut","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Retourne les \u00e9missions ATMO.\u003Cbr /\u003E\u003Cbr /\u003E\u003Ca target='_blank' href='/exemple_emissions.json'\u003EExemple de r\u00e9ponse\u003C/a\u003E"}}}},"/api/v2/data/indices/pollens":{"get":{"tags":["Indice pollen"],"summary":"R\u00e9cup\u00e9ration des indices pollen","description":"\u003Ca target='_blank' href='#'\u003ELien vers la documentation technique des indices polliniques\u003C/a\u003E","operationId":"get_indices_pollens","parameters":[{"name":"format","in":"query","description":"S\u00e9lection du format de sortie","required":false,"schema":{"type":"string","default":"geojson","enum":["geojson","csv"]}},{"name":"date","in":"query","description":"S\u00e9lection de la date","required":false,"schema":{"type":"string","format":"YYYY-MM-DD","example":"2024-06-08"}},{"name":"date_historique","in":"query","description":"S\u00e9lection des donn\u00e9es de la p\u00e9riode entre date_historique et date","required":false,"schema":{"type":"string","format":"YYYY-MM-DD","example":"2024-06-08"}},{"name":"code_zone","in":"query","description":"S\u00e9lection d'un ou plusieurs territoires par leur code INSEE (commune), tous par d\u00e9faut","required":false,"schema":{"type":"string"}},{"name":"aasqa","in":"query","description":"S\u00e9lection d'une ou plusieurs AASQA fournissant la donn\u00e9e, toutes par d\u00e9faut","required":false,"schema":{"type":"string","enum":["01","02","03","04","06","11","24","27","28","32","44","52","53","75","76","84","93","94"]}},{"name":"code_qualificatif","in":"query","description":"S\u00e9lection par valeur d'indice pollinique (0: Indisponible, 1: Tr\u00e8s faible, 2: Faible, 3: Mod\u00e9r\u00e9, 4: \u00c9lev\u00e9, 5: Tr\u00e8s \u00e9lev\u00e9, 6: Extr\u00eamement \u00e9lev\u00e9) , tous par d\u00e9faut ","required":false,"schema":{"description":"0 \u00e0 7 (Du meilleurs au plus mauvais)","type":"string","enum":["0","1","2","3","4","5","6"]}},{"name":"alerte","in":"query","description":"S\u00e9lection par valeur d'alerte (true: Active, false: Inactive), toutes par d\u00e9faut","required":false,"schema":{"type":"bool","enum":[true,false]}},{"name":"with_geom","in":"query","description":"R\u00e9cup\u00e9ration des g\u00e9om\u00e9tries (non par d\u00e9faut)","required":false,"schema":{"type":"bool","default":"false","enum":[true,false]}},{"name":"bounding_box","in":"query","description":"S\u00e9lection d\u2019un territoire d\u00e9fini par une bounding box","required":false,"schema":{"type":"string","format":"xmin ymin xmax ymax"}},{"name":"bounding_box_srs","in":"query","description":"EPSG de la bounding box, 4326 par d\u00e9faut","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Retourne les indices pollen.\u003Cbr /\u003E\u003Cbr /\u003E\u003Ca target='_blank' href='/exemple_pollens.json'\u003EExemple de r\u00e9ponse\u003C/a\u003E"}}}}},"components":{"securitySchemes":{"Bearer":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}}},"security":[{"Bearer":[]}],"tags":[{"name":"Indice de qualit\u00e9 de l'air"},{"name":"Episodes de pollution"},{"name":"Inventaires"},{"name":"Indice pollen"},{"name":"Connexion","description":"Connexion"}]}}
|