⥠đ Agora location [[api]] â
đ 04 - Documentation technique/api.md (contribution by @communecter) â đ âĄ
[toc]
API
AccĂšs Ă lâinterface graphique de lâAPI : communecter.org/api

Get : Récupérer des informations
Depuis lâAPI vous avez la possibilitĂ© de rĂ©cupĂ©rer diffĂ©rentes informations en provenance de Communecter :
[citoyens]Citoyen[organizations]Organisation[projects]Projet[events]ĂvĂ©nement[needs]Besoin[news]News
Récupérer toutes les entités
Structure
/api/[project || person || organization || event || need || news]/get/
Exemple
https://www.communecter.org/api/organization/get
Pour voir la description du rĂ©sultat aller dans la rubrique âLes attributsâ.
Paramétrer la recherche
Vous avez la possibilitĂ© dâajouter des paramĂštres pour peaufiner votre recherche :
[id]Identifiant[tags]Tags[insee]Code Insee[format]Format
Récupérer une entité via son identifiant
/ph/communecter/data/get/type/(projects || citoyens || organizations || events || news)/id/[id_entity]
Exemple : https://www.communecter.org/api/organization/get/id/57186ed894ef47210d7b242d
Rechercher par tags
Vous avez la possibilitĂ© de paramĂ©trer la recherche des entitĂ©s en fonctions des tags. Vous pouvez ajouter plusieurs tags qui devront ĂȘtre sĂ©parĂ© par une virgule. Par dĂ©fauts, si vous avez mis plusieurs tags, il suffit pour lâentitĂ© dâavoir un de ces tags pour ĂȘtre affichĂ©. Si vous souhaitez que lâentitĂ© possĂšde tout les tags alors il faut mettre le paramĂštre suivant : /multiTags/true
Exemples :
https://www.communecter.org/api/organization/get?tags=nuitdebout
https://www.communecter.org/api/organization/get?tags=education,social
https://www.communecter.org/api/organization/get?tags=education,social/multiTags/true
Rechercher par code Insee
Si vous connaissez le code Insee de votre commune, vous pouvez faire une recherche via ce code.
Exemple :
https://www.communecter.org/api/organization/get?insee=33402
Formats
LâAPI prend en compte diffĂ©rents formats pour le rĂ©sultat. Par dĂ©faut, câest le format que propose Communecter. Nous prenons aussi en comptes les formats suivant :
- SCHEMA
/ph/communecter/data/get/type/organizations/format/schema - PLP
/ph/communecter/data/get/type/citoyens/format/plp - RSS
/ph/api/news/get/format/rss - JSONFEED
/ph/api/news/get/format/jsonfeed - KML
/ph/api/event/get/format/kml - GEOJSON
/ph/api/person/get/format/geojson - CSV
/ph/api/person/get/format/csv
Attention certains formats ne retourne pas forcement toutes les entités, voici la liste pour chaque format.
COMMUNECTER
[citoyens]Citoyen[organizations]Organisation[projects]Projet[events]ĂvĂ©nement[needs]Besoin[news]News
SCHEMA
[citoyens]Citoyen[organizations]Organisation[projects]Projet[events]ĂvĂ©nement[needs]Besoin- City
[news]News
PLP
[citoyens]Citoyen
KML
[citoyens]Citoyen[organizations]Organisation[projects]Projet[events]ĂvĂ©nement[needs]Besoin- City
[news]News
GEOJSON
[citoyens]Citoyen[organizations]Organisation[projects]Projet[events]ĂvĂ©nement[needs]Besoin- City
[news]News
CSV
[organizations]Organisation
RSS
[news]news
JSONFEED
[news]news
Les attributs
Ici, vous aurez la description de tout les attribues des diffĂ©rentes entitĂ©s qui sont retournĂ©s via lâAPI.
Format Communecter
limitNombre dâentitĂ©s retournĂ©enexturl retournant la suite des entitĂ©spreviousurl retournant la liste prĂ©cĂ©dente des entitĂ©s
entities toutes les entités en leurs identifiants en clé
nameNom de lâentitĂ©imageUrl de lâimage de profil de lâentitĂ©urlCommunecterUrl de la fiche de lâentitĂ© sur CommunecterurlApiUrl qui retourne les informations dâune entitĂ© via lâAPI-
addressstreetAddressNuméro et nom de la ruepostalCodeCode postaladdressLocalityNom de la communeaddressCountryNom du PayscodeInseeCode Insee de la commune
-
geolatitudelongitude
geoPositionAutre format pour la position gĂ©ographique de lâentitĂ©shortDescriptionCourte description de lâentitĂ©descriptionDescription de lâentitĂ©.emailLâemail de lâentitĂ©.phoneLâensemble des numĂ©ros de tĂ©lĂ©phones de lâentitĂ© ( fixe, mobile et fax)socialNetworkLâensemble des liens vers les autres rĂ©seaux sociaux de lâentitĂ©tagsTous les tags associĂ©s Ă lâentitĂ©-
linksLes diffĂ©rents liens que lâentitĂ© a avec les autres :memberOfListe des organisations dont lâentitĂ© est membreprojectsListe des projets dont lâentitĂ© contribueeventsListe des Ă©vĂ©nements dont lâentitĂ© est invitĂ©e ou participefollowersListe des citoyens dont lâentitĂ© suit.membersListe des citoyens membres de lâentitĂ©.needsListe des besoins de lâentitĂ©.
Convert : Récupérer des données en onthologie PH
Depuis lâAPI, vous avez la possibilitĂ© de convertir les donnĂ©es sous diffĂ©rents format que vous possĂ©dez directement en onthologie PH.
-
[geojson]GeoJson -
[wikipedia]Json issu de lâAPI de Wikidata -
[datagouv]Json issu de lâAPI de Data.gouv -
[osm]Json issu de lâAPI de Open Street Map -
[ods]JSon issu de lâAPI de OpenDataSoft (on intĂ©roge uniquement la base SIRENE) -
[datanova]Json issu de lâAPI de Datanova -
[poleemploi]Json issu de lâAPI de PĂŽle Emploi -
[educstruct]Json issu de lâAPI de ScanR(structures de recherche) -
[educetab]Json issu de lâAPI de ScanR (Ă©tablissements impliquĂ©s dans la recherche) -
[educmembre]Json issu de lâAPI de ScanR (membre des universitĂ©s de France) -
[educecole]Json issu de lâAPI de ScanR (Ă©cole doctorales accrĂ©ditĂ©s)
Obtenir lâontologie ph pour un type dâĂ©lĂ©ment donnĂ©e via une url
Structure
/ph/communecter/api/convert/geojson/type/[organizations || citoyens || events || projects]?url="http://votreurl"
Exemple
https://www.communecter.org/api/convert/geojson/type/organizations?url=http://umap.openstreetmap.fr/en/datalayer/306808/
Cas particuliers : les uMap
Structure
LâAPI permet de convertir les donnĂ©es geojson dâune uMap donnĂ©e via la paramĂštre âurlâ.
On peut aussi mettre en paramĂštre lâURL courte dâune uMap (visible en appuyant sur le bouton partager Ă gauche de la uMap). Attention pour le moment, il faut que lâurl soit en âhttpâ et non pas en âhttpsâ, retirez le âsâ si tel est le cas.
https://www.communecter.org/api/convert/geojson/type/organizations?url=[URL]
Exemples
URL longue :
https://www.communecter.org/api/convert/geojson/type/organizations?url=http://umap.openstreetmap.fr/en/datalayer/306808/
URL Courte :
/ph/communecter/api/convert/type/organizations?url=http://u.osmfr.org/m/62176/
Obtenir lâontologie ph pour un type dâĂ©lĂ©ment donnĂ©e via un fichier
Il faut envoyer Ă lâAPI le paramĂštre âfileâ via mĂ©thode POST. (en utilisant curl ou RESTED par exemple).
Obtenir lâontologie ph pour une url intĂ©rrogeant une API externe
/ph/communecter/api/convert/[type interop]?url="http://votreurlinterop"
Wikidata
Structure
/ph/api/convert/wikipedia?url=https://www.wikidata.org/wiki/Special:EntityData/[wikidataID].json
Exemple
Ville de Saint-Louis - WikidataID = Q47045 :
/ph/api/convert/wikipedia?url=https://www.wikidata.org/wiki/Special:EntityData/Q47045.json
Data.gouv
Structure
/ph/api/convert/datagouv?url=https://www.data.gouv.fr/api/1/spatial/zone/fr/town/[insee]/datasets
Exemple
Ville de Rodez - Code INSEE 12202 :
/ph/api/convert/datagouv?url=https://www.data.gouv.fr/api/1/spatial/zone/fr/town/12202/datasets
On va pouvoir ensuite obtenir lâensemble des datasets de la ville mentionnĂ©e et au final parcourir lâensemble des diffĂ©rents jeux de donnĂ©es de la ville.
OpenStreetMap
Structure
/ph/api/convert/osm?url=http://overpass-api.de/api/interpreter?data=[out:json];node[%22name%22](poly:[geoshape]);out;
Exemple
Ville de Saint-Louis :
/ph/api/convert/osm?url=http://overpass-api.de/api/interpreter?data=[out:json];node[%22name%22](poly:%22-21.303505996763%2055.403919253998%20-21.292626813288%2055.391189163162%20-21.282029142394%2055.381522536523%20-21.256155186265%2055.392395046639%20-21.232012804782%2055.387888015185%20-21.211100938923%2055.390619722192%20-21.199480966855%2055.382654775478%20-21.185882138486%2055.385961778627%20-21.173346518752%2055.389949958731%20-21.16327583783%2055.399563417107%20-21.14709868917%2055.405379688232%20-21.166028899095%2055.414700890276%20-21.184085220909%2055.432085218794%20-21.190290936422%2055.440880800108%20-21.195166490948%2055.462318490892%20-21.237553168259%2055.459769285867%20-21.258726107298%2055.463692709631%20-21.286021128961%2055.455515913879%20-21.294777773557%2055.419916682666%20-21.303505996763%2055.403919253998%22);out;
On va pouvoir filtrer lâenssemble des noeuds qui sont prĂ©sent dans le geoshape fourni et enfin filtrer tous les noeuds qui possĂšde au moins le tag ânameâ.
OpenDataSoft
Structure
On va pouvoir filtrer lâensemble des Ă©lĂ©ments prĂ©sent dans le geofilter fournit. On peut filtrer les Ă©lĂ©ments par thĂ©matique en mentionnant des refine.libapen dans lâurl.
/ph/api/convert/ods?url=https://data.opendatasoft.com/api/records/1.0/search/?dataset=sirene%40public&sort=datemaj&facet=categorie&facet=proden&facet=libapen&facet=siege&facet=libreg_new&facet=saisonat&facet=libtefen&facet=depet&facet=libnj&facet=libtca&facet=liborigine&rows=30&start=0&geofilter.polygon=[geofilter]
Exemples
Ville de Saint-Louis :
/ph/api/convert/ods?url=https://data.opendatasoft.com/api/records/1.0/search/?dataset=sirene%40public&sort=datemaj&facet=categorie&facet=proden&facet=libapen&facet=siege&facet=libreg_new&facet=saisonat&facet=libtefen&facet=depet&facet=libnj&facet=libtca&facet=liborigine&rows=30&start=0&geofilter.polygon=(-21.303505996763,55.403919253998),(-21.292626813288,55.391189163162),(-21.282029142394,55.381522536523),(-21.256155186265,55.392395046639),(-21.232012804782,55.387888015185),(-21.211100938923,55.390619722192),(-21.199480966855,55.382654775478),(-21.185882138486,55.385961778627),(-21.173346518752,55.389949958731),(-21.16327583783,55.399563417107),(-21.14709868917,55.405379688232),(-21.166028899095,55.414700890276),(-21.184085220909,55.432085218794),(-21.190290936422,55.440880800108),(-21.195166490948,55.462318490892),(-21.237553168259,55.459769285867),(-21.258726107298,55.463692709631),(-21.286021128961,55.455515913879),(-21.294777773557,55.419916682666),(-21.303505996763,55.403919253998)
Lâexemple suivant fait la mĂȘme chose que lâexemple prĂ©cĂ©dent sauf quâil filtre tous les Ă©lĂ©ments qui sont dans le secteur dâactivitĂ© : Pratique dentaire
/ph/api/convert/ods?url=https://data.opendatasoft.com/api/records/1.0/search/?dataset=sirene%40public&facet=categorie&facet=proden&facet=libapen&facet=siege&facet=libreg_new&facet=saisonat&facet=libtefen&facet=depet&facet=libnj&facet=libtca&facet=liborigine&rows=30&start=0&geofilter.polygon=(44.810795852605,-0.5738778170842),(44.817148298105,-0.57643460444186),(44.823910193873,-0.58695822406613),(44.818476638462,-0.60304723869607),(44.822474304509,-0.61064859861704),(44.824937843733,-0.61415033833008),(44.835177466959,-0.61079419661495),(44.841384923705,-0.62771243191386),(44.860667021743,-0.63833642556746),(44.871658097695,-0.63105127891779),(44.86227970331,-0.61630176568479),(44.854215265872,-0.59460939385687),(44.865671076253,-0.57646019656194),(44.869188961886,-0.57608874140575),(44.909402227434,-0.58088555560083),(44.908480410411,-0.57648917779388),(44.916666965125,-0.54773554113942),(44.889099273803,-0.53553255107571),(44.869138522062,-0.54141014437767),(44.868086689933,-0.53680669655034),(44.861267174723,-0.53784686147751),(44.848134506953,-0.53761462401784),(44.842390488778,-0.5422310311368),(44.836291776079,-0.54665943781219),(44.829021270567,-0.53642317794196),(44.822772234064,-0.53766321563778),(44.813135278103,-0.55606047183132),(44.810795852605,-0.5738778170842)&refine.libapen=Pratique%20dentaire
Datanova
Structure
On rĂ©cupĂšre lâensemble des enseignes La Poste prĂ©sent dans le geofilter donnĂ©.
/ph/api/convert/datanova?url=https://datanova.laposte.fr/api/records/1.0/search/?dataset=laposte_poincont&rows=30&start=0&geofilter.polygon=[geofilter]
Exemple
Ville de Bordeaux
PĂŽle Emploi
Introduction
On demande Ă avoir un token :
https://entreprise.pole-emploi.fr/connexion/oauth2/access_token?realm=%2Fpartenaire
avec en paramĂštre POST :
- grant_type = client_credential
- client_id = [identifiant]
- scope = [mot de passe]
Ensuite on lance la requĂȘte :
https://api.emploi-store.fr/partenaire/infotravail/v1/datastore_search_sql?sql=SELECT%20%2A%20FROM%20%22421692f5%2Df342%2D4223%2D9c51%2D72a27dcaf51e%22%20WHERE%20%22CITY_CODE%22=%27[insee]%27%
Exemple (ville de Saint-Louis) :
https://api.emploi-store.fr/partenaire/infotravail/v1/datastore_search_sql?sql=SELECT%20%2A%20FROM%20%22421692f5%2Df342%2D4223%2D9c51%2D72a27dcaf51e%22%20WHERE%20%22CITY_CODE%22=%2797414%27%
Il faut indiquer en paramĂštre POST ses identifiants du PĂŽle Emploi (inscription sur emploi-store-dev.fr) et aussi mettre un token dans le HEADER : âAuthorization: Bearer [token]â.
Structure
Lâurl Ă passer en paramĂštre est du type :
/ph/api/convert?url=https://api.emploi-store.fr/partenaire/infotravail/v1/datastore_search_sql?sql=SELECT%20%2A%20FROM%20%22421692f5%2Df342%2D4223%2D9c51%2D72a27dcaf51e%22%20WHERE%20%22CITY_CODE%22=%27[insee]%27%
Exemples
Ville de Saint-Louis :
/ph/api/convert?url=https://api.emploi-store.fr/partenaire/infotravail/v1/datastore_search_sql?sql=SELECT%20%2A%20FROM%20%22421692f5%2Df342%2D4223%2D9c51%2D72a27dcaf51e%22%20WHERE%20%22CITY_CODE%22=%2797414%27%
ScanR
Structure
ScanR comporte 4 jeux de donnĂ©es que lâon peut intĂ©roger : Structure de recherche publique :
/ph/api/convert/educstruct?url=https://data.enseignementsup-recherche.gouv.fr/api/records/1.0/search/?dataset=fr-esr-structures-recherche-publiques-actives&facet=numero_national_de_structure&facet=annee_de_creation&facet=tutelles&facet=type_de_tutelle&facet=nature_de_tutelle&facet=nature_de_structure&facet=type_de_structure&facet=niveau_de_structure&facet=domaine_scientifique&facet=panel_erc&facet=theme_de_recherche&facet=commune&facet=unite_urbaine&facet=departement&facet=region&facet=pays&facet=comue&facet=region_avant_2016&rows=30&start=0&geofilter.polygon=[geofilter]
Etablissement impliqués dans la recherche :
/ph/api/convert/educetab?url=https://data.enseignementsup-recherche.gouv.fr/api/records/1.0/search/?dataset=fr-esr-etablissements-publics-prives-impliques-recherche-developpement&facet=siren&facet=libelle&facet=date_de_creation&facet=categorie&facet=libelle_ape&facet=tranche_etp&facet=categorie_juridique&facet=wikidata&facet=commune&facet=unite_urbaine&facet=departement&facet=region&facet=pays&facet=badge&facet=region_avant_2016&rows=30&start=0&geofilter.polygon=[geofilter]
Membres des universités de France :
/ph/api/convert/educmembre?url=https://data.enseignementsup-recherche.gouv.fr/api/records/1.0/search/?dataset=fr-esr-iuf-les-membres&rows=30&start=0&geofilter.polygon=[geofilter]
Liste des écoles doctorales accréditées :
/ph/api/convert/educecole?url=https://data.enseignementsup-recherche.gouv.fr/api/records/1.0/search/?dataset=fr-esr-ecoles_doctorales_annuaire&facet=numero&facet=groupe_disciplinaire&facet=toutes_les_disciplines&facet=discipline_principale&facet=localisation&facet=liste_tous_etablissements&facet=laboratoires_rattaches&facet=annee_de_creation&facet=annee_accreditation&facet=etablissement_support&facet=liste_codes_tous_etablissements&facet=identifiants_des_laboratoires&facet=libelle_unite_urbaine&facet=libelle_departement&facet=libelle_academie&facet=libelle_region&rows=30&start=0&geofilter.polygon=[geofilter]
Exemples
Structure de recherche publique de Saint-Louis :
/ph/api/convert/educstruct?url=https://data.enseignementsup-recherche.gouv.fr/api/records/1.0/search/?dataset=fr-esr-structures-recherche-publiques-actives&facet=numero_national_de_structure&facet=annee_de_creation&facet=tutelles&facet=type_de_tutelle&facet=nature_de_tutelle&facet=nature_de_structure&facet=type_de_structure&facet=niveau_de_structure&facet=domaine_scientifique&facet=panel_erc&facet=theme_de_recherche&facet=commune&facet=unite_urbaine&facet=departement&facet=region&facet=pays&facet=comue&facet=region_avant_2016&rows=30&start=0&geofilter.polygon=(44.810795852605,-0.5738778170842),(44.817148298105,-0.57643460444186),(44.823910193873,-0.58695822406613),(44.818476638462,-0.60304723869607),(44.822474304509,-0.61064859861704),(44.824937843733,-0.61415033833008),(44.835177466959,-0.61079419661495),(44.841384923705,-0.62771243191386),(44.860667021743,-0.63833642556746),(44.871658097695,-0.63105127891779),(44.86227970331,-0.61630176568479),(44.854215265872,-0.59460939385687),(44.865671076253,-0.57646019656194),(44.869188961886,-0.57608874140575),(44.909402227434,-0.58088555560083),(44.908480410411,-0.57648917779388),(44.916666965125,-0.54773554113942),(44.889099273803,-0.53553255107571),(44.869138522062,-0.54141014437767),(44.868086689933,-0.53680669655034),(44.861267174723,-0.53784686147751),(44.848134506953,-0.53761462401784),(44.842390488778,-0.5422310311368),(44.836291776079,-0.54665943781219),(44.829021270567,-0.53642317794196),(44.822772234064,-0.53766321563778),(44.813135278103,-0.55606047183132),(44.810795852605,-0.5738778170842)
Etablissement impliqués dans la recherche de Bordeaux :
/ph/api/convert/educetab?url=https://data.enseignementsup-recherche.gouv.fr/api/records/1.0/search/?dataset=fr-esr-etablissements-publics-prives-impliques-recherche-developpement&facet=siren&facet=libelle&facet=date_de_creation&facet=categorie&facet=libelle_ape&facet=tranche_etp&facet=categorie_juridique&facet=wikidata&facet=commune&facet=unite_urbaine&facet=departement&facet=region&facet=pays&facet=badge&facet=region_avant_2016&rows=30&start=0&geofilter.polygon=(44.810795852605,-0.5738778170842),(44.817148298105,-0.57643460444186),(44.823910193873,-0.58695822406613),(44.818476638462,-0.60304723869607),(44.822474304509,-0.61064859861704),(44.824937843733,-0.61415033833008),(44.835177466959,-0.61079419661495),(44.841384923705,-0.62771243191386),(44.860667021743,-0.63833642556746),(44.871658097695,-0.63105127891779),(44.86227970331,-0.61630176568479),(44.854215265872,-0.59460939385687),(44.865671076253,-0.57646019656194),(44.869188961886,-0.57608874140575),(44.909402227434,-0.58088555560083),(44.908480410411,-0.57648917779388),(44.916666965125,-0.54773554113942),(44.889099273803,-0.53553255107571),(44.869138522062,-0.54141014437767),(44.868086689933,-0.53680669655034),(44.861267174723,-0.53784686147751),(44.848134506953,-0.53761462401784),(44.842390488778,-0.5422310311368),(44.836291776079,-0.54665943781219),(44.829021270567,-0.53642317794196),(44.822772234064,-0.53766321563778),(44.813135278103,-0.55606047183132),(44.810795852605,-0.5738778170842)
Membres des universités de France de Bordeaux :
/ph/api/convert/educmembre?url=https://data.enseignementsup-recherche.gouv.fr/api/records/1.0/search/?dataset=fr-esr-iuf-les-membres&rows=30&start=0&geofilter.polygon=(44.810795852605,-0.5738778170842),(44.817148298105,-0.57643460444186),(44.823910193873,-0.58695822406613),(44.818476638462,-0.60304723869607),(44.822474304509,-0.61064859861704),(44.824937843733,-0.61415033833008),(44.835177466959,-0.61079419661495),(44.841384923705,-0.62771243191386),(44.860667021743,-0.63833642556746),(44.871658097695,-0.63105127891779),(44.86227970331,-0.61630176568479),(44.854215265872,-0.59460939385687),(44.865671076253,-0.57646019656194),(44.869188961886,-0.57608874140575),(44.909402227434,-0.58088555560083),(44.908480410411,-0.57648917779388),(44.916666965125,-0.54773554113942),(44.889099273803,-0.53553255107571),(44.869138522062,-0.54141014437767),(44.868086689933,-0.53680669655034),(44.861267174723,-0.53784686147751),(44.848134506953,-0.53761462401784),(44.842390488778,-0.5422310311368),(44.836291776079,-0.54665943781219),(44.829021270567,-0.53642317794196),(44.822772234064,-0.53766321563778),(44.813135278103,-0.55606047183132),(44.810795852605,-0.5738778170842)
Liste des écoles doctorales accréditées de Bordeaux :
/ph/api/convert/educecole?url=https://data.enseignementsup-recherche.gouv.fr/api/records/1.0/search/?dataset=fr-esr-ecoles_doctorales_annuaire&facet=numero&facet=groupe_disciplinaire&facet=toutes_les_disciplines&facet=discipline_principale&facet=localisation&facet=liste_tous_etablissements&facet=laboratoires_rattaches&facet=annee_de_creation&facet=annee_accreditation&facet=etablissement_support&facet=liste_codes_tous_etablissements&facet=identifiants_des_laboratoires&facet=libelle_unite_urbaine&facet=libelle_departement&facet=libelle_academie&facet=libelle_region&rows=30&start=0&geofilter.polygon=(44.810795852605,-0.5738778170842),(44.817148298105,-0.57643460444186),(44.823910193873,-0.58695822406613),(44.818476638462,-0.60304723869607),(44.822474304509,-0.61064859861704),(44.824937843733,-0.61415033833008),(44.835177466959,-0.61079419661495),(44.841384923705,-0.62771243191386),(44.860667021743,-0.63833642556746),(44.871658097695,-0.63105127891779),(44.86227970331,-0.61630176568479),(44.854215265872,-0.59460939385687),(44.865671076253,-0.57646019656194),(44.869188961886,-0.57608874140575),(44.909402227434,-0.58088555560083),(44.908480410411,-0.57648917779388),(44.916666965125,-0.54773554113942),(44.889099273803,-0.53553255107571),(44.869138522062,-0.54141014437767),(44.868086689933,-0.53680669655034),(44.861267174723,-0.53784686147751),(44.848134506953,-0.53761462401784),(44.842390488778,-0.5422310311368),(44.836291776079,-0.54665943781219),(44.829021270567,-0.53642317794196),(44.822772234064,-0.53766321563778),(44.813135278103,-0.55606047183132),(44.810795852605,-0.5738778170842)
REST Services
- Almost every actions could be exposed as a REST service.
Register a new user
- url : xxxxx.communecter.org/communecter/person/register
-
params dans le post :
namestringusernamestring. Unique on the plateformeemailwell formated emailcpexisting postalCodegeoPosLatitudefloatgeoPosLongitudefloatpwd :non encrypted passwordcityString Insee codependingUserIdString. Si lâutilisateur est dĂ©jĂ en base de donnĂ©es (il a Ă©tĂ© invitĂ© et son profil est temporaire), son identifiant est passĂ© en paramĂštre. Dans ce cas lâutilisateur nâest pas créé, mais il est mis Ă jour.
-
Retour (json) :
resultbooleanmsgString : message dâerreurididentifiant de lâutilisateur nouvellement créé.
-
Fonctionnement :
- Lâutilisateur est créé en base de donnĂ©es.
- Il nâest pas encore validĂ© et ne pourra pas se logguer
- Un mail lui est envoyé avec un lien de validation pour activer son compte
- En version bĂȘta, il y a un flag
betaTesterqui est positionnĂ© pour filtrer les utilisateurs bĂȘta testeur. Par dĂ©faut, il est Ăfalse.
đ en/04 - Documentation technique/api.md (contribution by @communecter) â đ âĄ
API
AccĂšs Ă lâinterface graphique de lâAPI : communecter.org/api

Get : Récupérer des informations
Depuis lâAPI vous avez la possibilitĂ© de rĂ©cupĂ©rer diffĂ©rentes informations en provenance de Communecter :
[citoyens]Citoyen[organizations]Organisation[projects]Projet[events]ĂvĂ©nement[needs]Besoin[news]News
Récupérer toutes les entités
Structure
/api/[project || person || organization || event || need || news]/get/
Exemple
https://www.communecter.org/api/organization/get
Pour voir la description du rĂ©sultat aller dans la rubrique âLes attributsâ.
Paramétrer la recherche
Vous avez la possibilitĂ© dâajouter des paramĂštres pour peaufiner votre recherche :
[id]Identifiant[tags]Tags[insee]Code Insee[format]Format
Récupérer une entité via son identifiant
/ph/communecter/data/get/type/(projects || citoyens || organizations || events || news)/id/[id_entity]
Exemple : https://www.communecter.org/api/organization/get/id/57186ed894ef47210d7b242d
Rechercher par tags
Vous avez la possibilitĂ© de paramĂ©trer la recherche des entitĂ©s en fonctions des tags. Vous pouvez ajouter plusieurs tags qui devront ĂȘtre sĂ©parĂ© par une virgule. Par dĂ©fauts, si vous avez mis plusieurs tags, il suffit pour lâentitĂ© dâavoir un de ces tags pour ĂȘtre affichĂ©. Si vous souhaitez que lâentitĂ© possĂšde tout les tags alors il faut mettre le paramĂštre suivant : /multiTags/true
Exemples :
https://www.communecter.org/api/organization/get?tags=nuitdebout
https://www.communecter.org/api/organization/get?tags=education,social
https://www.communecter.org/api/organization/get?tags=education,social/multiTags/true
Rechercher par code Insee
Si vous connaissez le code Insee de votre commune, vous pouvez faire une recherche via ce code.
Exemple :
https://www.communecter.org/api/organization/get?insee=33402
Formats
LâAPI prend en compte diffĂ©rents formats pour le rĂ©sultat. Par dĂ©faut, câest le format que propose Communecter. Nous prenons aussi en comptes les formats suivant :
- SCHEMA
/ph/communecter/data/get/type/organizations/format/schema - PLP
/ph/communecter/data/get/type/citoyens/format/plp - RSS
/ph/api/news/get/format/rss - JSONFEED
/ph/api/news/get/format/jsonfeed - KML
/ph/api/event/get/format/kml - GEOJSON
/ph/api/person/get/format/geojson - CSV
/ph/api/person/get/format/csv
Attention certains formats ne retourne pas forcement toutes les entités, voici la liste pour chaque format.
COMMUNECTER
[citoyens]Citoyen[organizations]Organisation[projects]Projet[events]ĂvĂ©nement[needs]Besoin[news]News
SCHEMA
[citoyens]Citoyen[organizations]Organisation[projects]Projet[events]ĂvĂ©nement[needs]Besoin- City
[news]News
PLP
[citoyens]Citoyen
KML
[citoyens]Citoyen[organizations]Organisation[projects]Projet[events]ĂvĂ©nement[needs]Besoin- City
[news]News
GEOJSON
[citoyens]Citoyen[organizations]Organisation[projects]Projet[events]ĂvĂ©nement[needs]Besoin- City
[news]News
CSV
[organizations]Organisation
RSS
[news]news
JSONFEED
[news]news
Les attributs
Ici, vous aurez la description de tout les attribues des diffĂ©rentes entitĂ©s qui sont retournĂ©s via lâAPI.
Format Communecter
limitNombre dâentitĂ©s retournĂ©enexturl retournant la suite des entitĂ©spreviousurl retournant la liste prĂ©cĂ©dente des entitĂ©s
entities toutes les entités en leurs identifiants en clé
nameNom de lâentitĂ©imageUrl de lâimage de profil de lâentitĂ©urlCommunecterUrl de la fiche de lâentitĂ© sur CommunecterurlApiUrl qui retourne les informations dâune entitĂ© via lâAPI-
addressstreetAddressNuméro et nom de la ruepostalCodeCode postaladdressLocalityNom de la communeaddressCountryNom du PayscodeInseeCode Insee de la commune
-
geolatitudelongitude
geoPositionAutre format pour la position gĂ©ographique de lâentitĂ©shortDescriptionCourte description de lâentitĂ©descriptionDescription de lâentitĂ©.emailLâemail de lâentitĂ©.phoneLâensemble des numĂ©ros de tĂ©lĂ©phones de lâentitĂ© ( fixe, mobile et fax)socialNetworkLâensemble des liens vers les autres rĂ©seaux sociaux de lâentitĂ©tagsTous les tags associĂ©s Ă lâentitĂ©-
linksLes diffĂ©rents liens que lâentitĂ© a avec les autres :memberOfListe des organisations dont lâentitĂ© est membreprojectsListe des projets dont lâentitĂ© contribueeventsListe des Ă©vĂ©nements dont lâentitĂ© est invitĂ©e ou participefollowersListe des citoyens dont lâentitĂ© suit.membersListe des citoyens membres de lâentitĂ©.needsListe des besoins de lâentitĂ©.
Convert : Récupérer des données en onthologie PH
Depuis lâAPI, vous avez la possibilitĂ© de convertir les donnĂ©es sous diffĂ©rents format que vous possĂ©dez directement en onthologie PH.
-
[geojson]GeoJson -
[wikipedia]Json issu de lâAPI de Wikidata -
[datagouv]Json issu de lâAPI de Data.gouv -
[osm]Json issu de lâAPI de Open Street Map -
[ods]JSon issu de lâAPI de OpenDataSoft (on intĂ©roge uniquement la base SIRENE) -
[datanova]Json issu de lâAPI de Datanova -
[poleemploi]Json issu de lâAPI de PĂŽle Emploi -
[educstruct]Json issu de lâAPI de ScanR(structures de recherche) -
[educetab]Json issu de lâAPI de ScanR (Ă©tablissements impliquĂ©s dans la recherche) -
[educmembre]Json issu de lâAPI de ScanR (membre des universitĂ©s de France) -
[educecole]Json issu de lâAPI de ScanR (Ă©cole doctorales accrĂ©ditĂ©s)
Obtenir lâontologie ph pour un type dâĂ©lĂ©ment donnĂ©e via une url
Structure
/ph/communecter/api/convert/geojson/type/[organizations || citoyens || events || projects]?url="http://votreurl"
Exemple
https://www.communecter.org/api/convert/geojson/type/organizations?url=http://umap.openstreetmap.fr/en/datalayer/306808/
Cas particuliers : les uMap
Structure
LâAPI permet de convertir les donnĂ©es geojson dâune uMap donnĂ©e via la paramĂštre âurlâ.
On peut aussi mettre en paramĂštre lâURL courte dâune uMap (visible en appuyant sur le bouton partager Ă gauche de la uMap). Attention pour le moment, il faut que lâurl soit en âhttpâ et non pas en âhttpsâ, retirez le âsâ si tel est le cas.
https://www.communecter.org/api/convert/geojson/type/organizations?url=[URL]
Exemples
URL longue :
https://www.communecter.org/api/convert/geojson/type/organizations?url=http://umap.openstreetmap.fr/en/datalayer/306808/
URL Courte :
/ph/communecter/api/convert/type/organizations?url=http://u.osmfr.org/m/62176/
Obtenir lâontologie ph pour un type dâĂ©lĂ©ment donnĂ©e via un fichier
Il faut envoyer Ă lâAPI le paramĂštre âfileâ via mĂ©thode POST. (en utilisant curl ou RESTED par exemple).
Obtenir lâontologie ph pour une url intĂ©rrogeant une API externe
/ph/communecter/api/convert/[type interop]?url="http://votreurlinterop"
Wikidata
Structure
/ph/api/convert/wikipedia?url=https://www.wikidata.org/wiki/Special:EntityData/[wikidataID].json
Exemple
Ville de Saint-Louis - WikidataID = Q47045 :
/ph/api/convert/wikipedia?url=https://www.wikidata.org/wiki/Special:EntityData/Q47045.json
Data.gouv
Structure
/ph/api/convert/datagouv?url=https://www.data.gouv.fr/api/1/spatial/zone/fr/town/[insee]/datasets
Exemple
Ville de Rodez - Code INSEE 12202 :
/ph/api/convert/datagouv?url=https://www.data.gouv.fr/api/1/spatial/zone/fr/town/12202/datasets
On va pouvoir ensuite obtenir lâensemble des datasets de la ville mentionnĂ©e et au final parcourir lâensemble des diffĂ©rents jeux de donnĂ©es de la ville.
OpenStreetMap
Structure
/ph/api/convert/osm?url=http://overpass-api.de/api/interpreter?data=[out:json];node[%22name%22](poly:[geoshape]);out;
Exemple
Ville de Saint-Louis :
/ph/api/convert/osm?url=http://overpass-api.de/api/interpreter?data=[out:json];node[%22name%22](poly:%22-21.303505996763%2055.403919253998%20-21.292626813288%2055.391189163162%20-21.282029142394%2055.381522536523%20-21.256155186265%2055.392395046639%20-21.232012804782%2055.387888015185%20-21.211100938923%2055.390619722192%20-21.199480966855%2055.382654775478%20-21.185882138486%2055.385961778627%20-21.173346518752%2055.389949958731%20-21.16327583783%2055.399563417107%20-21.14709868917%2055.405379688232%20-21.166028899095%2055.414700890276%20-21.184085220909%2055.432085218794%20-21.190290936422%2055.440880800108%20-21.195166490948%2055.462318490892%20-21.237553168259%2055.459769285867%20-21.258726107298%2055.463692709631%20-21.286021128961%2055.455515913879%20-21.294777773557%2055.419916682666%20-21.303505996763%2055.403919253998%22);out;
On va pouvoir filtrer lâenssemble des noeuds qui sont prĂ©sent dans le geoshape fourni et enfin filtrer tous les noeuds qui possĂšde au moins le tag ânameâ.
OpenDataSoft
Structure
On va pouvoir filtrer lâensemble des Ă©lĂ©ments prĂ©sent dans le geofilter fournit. On peut filtrer les Ă©lĂ©ments par thĂ©matique en mentionnant des refine.libapen dans lâurl.
/ph/api/convert/ods?url=https://data.opendatasoft.com/api/records/1.0/search/?dataset=sirene%40public&sort=datemaj&facet=categorie&facet=proden&facet=libapen&facet=siege&facet=libreg_new&facet=saisonat&facet=libtefen&facet=depet&facet=libnj&facet=libtca&facet=liborigine&rows=30&start=0&geofilter.polygon=[geofilter]
Exemples
Ville de Saint-Louis :
/ph/api/convert/ods?url=https://data.opendatasoft.com/api/records/1.0/search/?dataset=sirene%40public&sort=datemaj&facet=categorie&facet=proden&facet=libapen&facet=siege&facet=libreg_new&facet=saisonat&facet=libtefen&facet=depet&facet=libnj&facet=libtca&facet=liborigine&rows=30&start=0&geofilter.polygon=(-21.303505996763,55.403919253998),(-21.292626813288,55.391189163162),(-21.282029142394,55.381522536523),(-21.256155186265,55.392395046639),(-21.232012804782,55.387888015185),(-21.211100938923,55.390619722192),(-21.199480966855,55.382654775478),(-21.185882138486,55.385961778627),(-21.173346518752,55.389949958731),(-21.16327583783,55.399563417107),(-21.14709868917,55.405379688232),(-21.166028899095,55.414700890276),(-21.184085220909,55.432085218794),(-21.190290936422,55.440880800108),(-21.195166490948,55.462318490892),(-21.237553168259,55.459769285867),(-21.258726107298,55.463692709631),(-21.286021128961,55.455515913879),(-21.294777773557,55.419916682666),(-21.303505996763,55.403919253998)
Lâexemple suivant fait la mĂȘme chose que lâexemple prĂ©cĂ©dent sauf quâil filtre tous les Ă©lĂ©ments qui sont dans le secteur dâactivitĂ© : Pratique dentaire
/ph/api/convert/ods?url=https://data.opendatasoft.com/api/records/1.0/search/?dataset=sirene%40public&facet=categorie&facet=proden&facet=libapen&facet=siege&facet=libreg_new&facet=saisonat&facet=libtefen&facet=depet&facet=libnj&facet=libtca&facet=liborigine&rows=30&start=0&geofilter.polygon=(44.810795852605,-0.5738778170842),(44.817148298105,-0.57643460444186),(44.823910193873,-0.58695822406613),(44.818476638462,-0.60304723869607),(44.822474304509,-0.61064859861704),(44.824937843733,-0.61415033833008),(44.835177466959,-0.61079419661495),(44.841384923705,-0.62771243191386),(44.860667021743,-0.63833642556746),(44.871658097695,-0.63105127891779),(44.86227970331,-0.61630176568479),(44.854215265872,-0.59460939385687),(44.865671076253,-0.57646019656194),(44.869188961886,-0.57608874140575),(44.909402227434,-0.58088555560083),(44.908480410411,-0.57648917779388),(44.916666965125,-0.54773554113942),(44.889099273803,-0.53553255107571),(44.869138522062,-0.54141014437767),(44.868086689933,-0.53680669655034),(44.861267174723,-0.53784686147751),(44.848134506953,-0.53761462401784),(44.842390488778,-0.5422310311368),(44.836291776079,-0.54665943781219),(44.829021270567,-0.53642317794196),(44.822772234064,-0.53766321563778),(44.813135278103,-0.55606047183132),(44.810795852605,-0.5738778170842)&refine.libapen=Pratique%20dentaire
Datanova
Structure
On rĂ©cupĂšre lâensemble des enseignes La Poste prĂ©sent dans le geofilter donnĂ©.
/ph/api/convert/datanova?url=https://datanova.laposte.fr/api/records/1.0/search/?dataset=laposte_poincont&rows=30&start=0&geofilter.polygon=[geofilter]
Exemple
Ville de Bordeaux
PĂŽle Emploi
Introduction
On demande Ă avoir un token :
https://entreprise.pole-emploi.fr/connexion/oauth2/access_token?realm=%2Fpartenaire
avec en paramĂštre POST :
- grant_type = client_credential
- client_id = [identifiant]
- scope = [mot de passe]
Ensuite on lance la requĂȘte :
https://api.emploi-store.fr/partenaire/infotravail/v1/datastore_search_sql?sql=SELECT%20%2A%20FROM%20%22421692f5%2Df342%2D4223%2D9c51%2D72a27dcaf51e%22%20WHERE%20%22CITY_CODE%22=%27[insee]%27%
Exemple (ville de Saint-Louis) :
https://api.emploi-store.fr/partenaire/infotravail/v1/datastore_search_sql?sql=SELECT%20%2A%20FROM%20%22421692f5%2Df342%2D4223%2D9c51%2D72a27dcaf51e%22%20WHERE%20%22CITY_CODE%22=%2797414%27%
Il faut indiquer en paramĂštre POST ses identifiants du PĂŽle Emploi (inscription sur emploi-store-dev.fr) et aussi mettre un token dans le HEADER : âAuthorization: Bearer [token]â.
Structure
Lâurl Ă passer en paramĂštre est du type :
/ph/api/convert?url=https://api.emploi-store.fr/partenaire/infotravail/v1/datastore_search_sql?sql=SELECT%20%2A%20FROM%20%22421692f5%2Df342%2D4223%2D9c51%2D72a27dcaf51e%22%20WHERE%20%22CITY_CODE%22=%27[insee]%27%
Exemples
Ville de Saint-Louis :
/ph/api/convert?url=https://api.emploi-store.fr/partenaire/infotravail/v1/datastore_search_sql?sql=SELECT%20%2A%20FROM%20%22421692f5%2Df342%2D4223%2D9c51%2D72a27dcaf51e%22%20WHERE%20%22CITY_CODE%22=%2797414%27%
ScanR
Structure
ScanR comporte 4 jeux de donnĂ©es que lâon peut intĂ©roger : Structure de recherche publique :
/ph/api/convert/educstruct?url=https://data.enseignementsup-recherche.gouv.fr/api/records/1.0/search/?dataset=fr-esr-structures-recherche-publiques-actives&facet=numero_national_de_structure&facet=annee_de_creation&facet=tutelles&facet=type_de_tutelle&facet=nature_de_tutelle&facet=nature_de_structure&facet=type_de_structure&facet=niveau_de_structure&facet=domaine_scientifique&facet=panel_erc&facet=theme_de_recherche&facet=commune&facet=unite_urbaine&facet=departement&facet=region&facet=pays&facet=comue&facet=region_avant_2016&rows=30&start=0&geofilter.polygon=[geofilter]
Etablissement impliqués dans la recherche :
/ph/api/convert/educetab?url=https://data.enseignementsup-recherche.gouv.fr/api/records/1.0/search/?dataset=fr-esr-etablissements-publics-prives-impliques-recherche-developpement&facet=siren&facet=libelle&facet=date_de_creation&facet=categorie&facet=libelle_ape&facet=tranche_etp&facet=categorie_juridique&facet=wikidata&facet=commune&facet=unite_urbaine&facet=departement&facet=region&facet=pays&facet=badge&facet=region_avant_2016&rows=30&start=0&geofilter.polygon=[geofilter]
Membres des universités de France :
/ph/api/convert/educmembre?url=https://data.enseignementsup-recherche.gouv.fr/api/records/1.0/search/?dataset=fr-esr-iuf-les-membres&rows=30&start=0&geofilter.polygon=[geofilter]
Liste des écoles doctorales accréditées :
/ph/api/convert/educecole?url=https://data.enseignementsup-recherche.gouv.fr/api/records/1.0/search/?dataset=fr-esr-ecoles_doctorales_annuaire&facet=numero&facet=groupe_disciplinaire&facet=toutes_les_disciplines&facet=discipline_principale&facet=localisation&facet=liste_tous_etablissements&facet=laboratoires_rattaches&facet=annee_de_creation&facet=annee_accreditation&facet=etablissement_support&facet=liste_codes_tous_etablissements&facet=identifiants_des_laboratoires&facet=libelle_unite_urbaine&facet=libelle_departement&facet=libelle_academie&facet=libelle_region&rows=30&start=0&geofilter.polygon=[geofilter]
Exemples
Structure de recherche publique de Saint-Louis :
/ph/api/convert/educstruct?url=https://data.enseignementsup-recherche.gouv.fr/api/records/1.0/search/?dataset=fr-esr-structures-recherche-publiques-actives&facet=numero_national_de_structure&facet=annee_de_creation&facet=tutelles&facet=type_de_tutelle&facet=nature_de_tutelle&facet=nature_de_structure&facet=type_de_structure&facet=niveau_de_structure&facet=domaine_scientifique&facet=panel_erc&facet=theme_de_recherche&facet=commune&facet=unite_urbaine&facet=departement&facet=region&facet=pays&facet=comue&facet=region_avant_2016&rows=30&start=0&geofilter.polygon=(44.810795852605,-0.5738778170842),(44.817148298105,-0.57643460444186),(44.823910193873,-0.58695822406613),(44.818476638462,-0.60304723869607),(44.822474304509,-0.61064859861704),(44.824937843733,-0.61415033833008),(44.835177466959,-0.61079419661495),(44.841384923705,-0.62771243191386),(44.860667021743,-0.63833642556746),(44.871658097695,-0.63105127891779),(44.86227970331,-0.61630176568479),(44.854215265872,-0.59460939385687),(44.865671076253,-0.57646019656194),(44.869188961886,-0.57608874140575),(44.909402227434,-0.58088555560083),(44.908480410411,-0.57648917779388),(44.916666965125,-0.54773554113942),(44.889099273803,-0.53553255107571),(44.869138522062,-0.54141014437767),(44.868086689933,-0.53680669655034),(44.861267174723,-0.53784686147751),(44.848134506953,-0.53761462401784),(44.842390488778,-0.5422310311368),(44.836291776079,-0.54665943781219),(44.829021270567,-0.53642317794196),(44.822772234064,-0.53766321563778),(44.813135278103,-0.55606047183132),(44.810795852605,-0.5738778170842)
Etablissement impliqués dans la recherche de Bordeaux :
/ph/api/convert/educetab?url=https://data.enseignementsup-recherche.gouv.fr/api/records/1.0/search/?dataset=fr-esr-etablissements-publics-prives-impliques-recherche-developpement&facet=siren&facet=libelle&facet=date_de_creation&facet=categorie&facet=libelle_ape&facet=tranche_etp&facet=categorie_juridique&facet=wikidata&facet=commune&facet=unite_urbaine&facet=departement&facet=region&facet=pays&facet=badge&facet=region_avant_2016&rows=30&start=0&geofilter.polygon=(44.810795852605,-0.5738778170842),(44.817148298105,-0.57643460444186),(44.823910193873,-0.58695822406613),(44.818476638462,-0.60304723869607),(44.822474304509,-0.61064859861704),(44.824937843733,-0.61415033833008),(44.835177466959,-0.61079419661495),(44.841384923705,-0.62771243191386),(44.860667021743,-0.63833642556746),(44.871658097695,-0.63105127891779),(44.86227970331,-0.61630176568479),(44.854215265872,-0.59460939385687),(44.865671076253,-0.57646019656194),(44.869188961886,-0.57608874140575),(44.909402227434,-0.58088555560083),(44.908480410411,-0.57648917779388),(44.916666965125,-0.54773554113942),(44.889099273803,-0.53553255107571),(44.869138522062,-0.54141014437767),(44.868086689933,-0.53680669655034),(44.861267174723,-0.53784686147751),(44.848134506953,-0.53761462401784),(44.842390488778,-0.5422310311368),(44.836291776079,-0.54665943781219),(44.829021270567,-0.53642317794196),(44.822772234064,-0.53766321563778),(44.813135278103,-0.55606047183132),(44.810795852605,-0.5738778170842)
Membres des universités de France de Bordeaux :
/ph/api/convert/educmembre?url=https://data.enseignementsup-recherche.gouv.fr/api/records/1.0/search/?dataset=fr-esr-iuf-les-membres&rows=30&start=0&geofilter.polygon=(44.810795852605,-0.5738778170842),(44.817148298105,-0.57643460444186),(44.823910193873,-0.58695822406613),(44.818476638462,-0.60304723869607),(44.822474304509,-0.61064859861704),(44.824937843733,-0.61415033833008),(44.835177466959,-0.61079419661495),(44.841384923705,-0.62771243191386),(44.860667021743,-0.63833642556746),(44.871658097695,-0.63105127891779),(44.86227970331,-0.61630176568479),(44.854215265872,-0.59460939385687),(44.865671076253,-0.57646019656194),(44.869188961886,-0.57608874140575),(44.909402227434,-0.58088555560083),(44.908480410411,-0.57648917779388),(44.916666965125,-0.54773554113942),(44.889099273803,-0.53553255107571),(44.869138522062,-0.54141014437767),(44.868086689933,-0.53680669655034),(44.861267174723,-0.53784686147751),(44.848134506953,-0.53761462401784),(44.842390488778,-0.5422310311368),(44.836291776079,-0.54665943781219),(44.829021270567,-0.53642317794196),(44.822772234064,-0.53766321563778),(44.813135278103,-0.55606047183132),(44.810795852605,-0.5738778170842)
Liste des écoles doctorales accréditées de Bordeaux :
/ph/api/convert/educecole?url=https://data.enseignementsup-recherche.gouv.fr/api/records/1.0/search/?dataset=fr-esr-ecoles_doctorales_annuaire&facet=numero&facet=groupe_disciplinaire&facet=toutes_les_disciplines&facet=discipline_principale&facet=localisation&facet=liste_tous_etablissements&facet=laboratoires_rattaches&facet=annee_de_creation&facet=annee_accreditation&facet=etablissement_support&facet=liste_codes_tous_etablissements&facet=identifiants_des_laboratoires&facet=libelle_unite_urbaine&facet=libelle_departement&facet=libelle_academie&facet=libelle_region&rows=30&start=0&geofilter.polygon=(44.810795852605,-0.5738778170842),(44.817148298105,-0.57643460444186),(44.823910193873,-0.58695822406613),(44.818476638462,-0.60304723869607),(44.822474304509,-0.61064859861704),(44.824937843733,-0.61415033833008),(44.835177466959,-0.61079419661495),(44.841384923705,-0.62771243191386),(44.860667021743,-0.63833642556746),(44.871658097695,-0.63105127891779),(44.86227970331,-0.61630176568479),(44.854215265872,-0.59460939385687),(44.865671076253,-0.57646019656194),(44.869188961886,-0.57608874140575),(44.909402227434,-0.58088555560083),(44.908480410411,-0.57648917779388),(44.916666965125,-0.54773554113942),(44.889099273803,-0.53553255107571),(44.869138522062,-0.54141014437767),(44.868086689933,-0.53680669655034),(44.861267174723,-0.53784686147751),(44.848134506953,-0.53761462401784),(44.842390488778,-0.5422310311368),(44.836291776079,-0.54665943781219),(44.829021270567,-0.53642317794196),(44.822772234064,-0.53766321563778),(44.813135278103,-0.55606047183132),(44.810795852605,-0.5738778170842)
REST Services
- Almost every actions could be exposed as a REST service.
Register a new user
- url : xxxxx.communecter.org/communecter/person/register
-
params dans le post :
namestringusernamestring. Unique on the plateformeemailwell formated emailcpexisting postalCodegeoPosLatitudefloatgeoPosLongitudefloatpwd :non encrypted passwordcityString Insee codependingUserIdString. Si lâutilisateur est dĂ©jĂ en base de donnĂ©es (il a Ă©tĂ© invitĂ© et son profil est temporaire), son identifiant est passĂ© en paramĂštre. Dans ce cas lâutilisateur nâest pas créé, mais il est mis Ă jour.
-
Retour (json) :
resultbooleanmsgString : message dâerreurididentifiant de lâutilisateur nouvellement créé.
-
Fonctionnement :
- Lâutilisateur est créé en base de donnĂ©es.
- Il nâest pas encore validĂ© et ne pourra pas se logguer
- Un mail lui est envoyé avec un lien de validation pour activer son compte
- En version bĂȘta, il y a un flag
betaTesterqui est positionnĂ© pour filtrer les utilisateurs bĂȘta testeur. Par dĂ©faut, il est Ăfalse.
đ API.md (contribution by @agora@botsin.space) â đ âĄ
đ app/storage/api.py (contribution by @agora-server) â đ âĄ
(Python code, output might appear as a push if this Agora supports it.)
đ en/Images/API.png (contribution by @communecter) â đ âĄ
đ Images/API.png (contribution by @communecter) â đ âĄ
âš AI Synthesis Mistral Gemini ChatGPT Claude
Expanding this section will automatically generate an AI synthesis of the contributions in this node.