{"id":1267,"date":"2020-11-09T14:06:04","date_gmt":"2020-11-09T13:06:04","guid":{"rendered":"http:\/\/perso.ens-lyon.fr\/lise.vaudor\/?p=1267"},"modified":"2021-01-04T09:24:18","modified_gmt":"2021-01-04T08:24:18","slug":"geocodage-sous-r-via-une-api","status":"publish","type":"post","link":"https:\/\/perso.ens-lyon.fr\/lise.vaudor\/geocodage-sous-r-via-une-api\/","title":{"rendered":"G\u00e9ocodage sous R via une API"},"content":{"rendered":"

\"\"<\/p>\n

G\u00e9ocodage via une API: was ist das?<\/h1>\n

\"\"<\/p>\n

G\u00e9ocodage<\/h2>\n

Le g\u00e9ocodage d\u2019abord<\/strong>: Il s\u2019agit d\u2019une op\u00e9ration qui consiste \u00e0 associer des coordonn\u00e9es g\u00e9ographiques<\/strong> \u00e0 un nom de lieu<\/strong> ou une adresse<\/strong>. C\u2019est donc une op\u00e9ration incontournable si vous disposez par exemple d\u2019un jeu de donn\u00e9es comprenant des lieux sous forme de cha\u00eenes de caract\u00e8re, et que vous voudriez l\u2019utiliser pour produire une carte<\/strong>.<\/p>\n

API<\/h2>\n

Qu\u2019est-ce qu\u2019une API<\/strong>, maintenant:<\/p>\n

API<\/strong> cela veut dire Application Programming Interface<\/strong>. C\u2019est un service qui permet aux d\u00e9veloppeurs de r\u00e9cup\u00e9rer des donn\u00e9es via internet pour les utiliser dans leurs applications. Imaginez par exemple que, aiguillonn\u00e9 par la faim, vous vous rendiez sur un site de commande de repas en ligne pour commander un burgher. Pour que seuls s\u2019affichent les restaurants qui peuvent vous livrer et faire en sorte de vous fournir un temps d\u2019attente probable, les d\u00e9veloppeurs de ce site ont fait en sorte de r\u00e9cup\u00e9rer votre position \u00e0 partir de l\u2019adresse postale que vous leur avez fournie. Cette op\u00e9ration se fait automatiquement, \u00e0 travers une API de g\u00e9ocodage (celle de Google par exemple). Dans ce cas, on comprend bien pourquoi cela s\u2019appelle une API: l\u2019interface<\/strong> du service vous permet de r\u00e9cup\u00e9rer des donn\u00e9es, qui seront utilis\u00e9es dans une autre application<\/strong> (ici le site de vente de burghers en livraison).<\/p>\n

J\u2019en ai vraiment besoin?<\/h2>\n

\u201cMais moi je suis pas d\u00e9veloppeur\u201d me direz-vous peut-\u00eatre. Effectivement, vous n\u2019avez peut-\u00eatre pas l\u2019intention de construire un site web ou une application qui sollicitera r\u00e9guli\u00e8rement telle ou telle API. Mais sans d\u00e9velopper une application \u00e0 proprement parler vous pouvez tout-de-m\u00eame avoir besoin de g\u00e9ocoder un certain nombre d\u2019adresses de mani\u00e8re automatique\u2026 Dans ce cas vous aurez une utilisation d\u2019API ponctuelle et limit\u00e9e \u00e0 un nombre fixe de requ\u00eates<\/strong> (le nombre d\u2019\u00e9l\u00e9ments que vous voulez g\u00e9ocoder pour compl\u00e9ter votre jeu de donn\u00e9es)\u2026 \u00e7a tombe bien, souvent l\u2019utilisation gratuite des API est limit\u00e9e \u00e0 un certain nombre de requ\u00eates par jour ou seconde (ben oui parce que c\u2019est un service, et un service c\u2019est rarement gratuit, sauf peut-\u00eatre si c\u2019est un petit service).<\/p>\n

Personnellement, les quelques fois o\u00f9 j\u2019ai souhait\u00e9 faire du g\u00e9ocodage, c\u2019\u00e9tait dans le but d\u2019exploiter les renseignements de localisation d\u2019utilisateurs Twitter<\/strong>: \u00e7a signifiait g\u00e9ocoder des noms de lieux renseign\u00e9s \u00e0 des niveaux de pr\u00e9cision et d\u2019exactitude divers (par exemple \u201cQuartier Beauregard, Trifouillis-les-Oies\u201d, ou juste \u201cFrance\u201d, ou \u201cAllemagne et USA\u201d, ou encore \u201cJe suis partout o\u00f9 le vent me porte\u201d\u2026 cette rubrique des profils Twitter pouvant \u00eatre renseign\u00e9e -ou au contraire laiss\u00e9e vide- totalement librement). Je souhaitais r\u00e9cup\u00e9rer non seulement la localisation (latitude-longitude)<\/strong> mais aussi des informations d\u2019appartenance<\/strong> (\u00e0 une ville, ou un pays) \u00e0 l\u2019\u00e9chelle la plus fine possible selon le degr\u00e9 de pr\u00e9cision avec lequel l\u2019utilisateur avait sp\u00e9cifi\u00e9 sa localisation.<\/p>\n

Il existe diverses API<\/strong> qui permettent de r\u00e9aliser le g\u00e9ocodage de noms de lieux et de r\u00e9cup\u00e9rer non seulement la localisation mais \u00e9galement divers renseignements. Dans ce billet, je parlerai de l\u2019API de g\u00e9ocodage de Google<\/strong>, de l\u2019API Opencage<\/strong>, et de l\u2019API Nominatim<\/strong> d\u2019OSM.<\/p>\n

Exemple<\/h2>\n

Dans la suite de ce billet je testerai ces trois API pour collecter des informations sur les lieux suivants:<\/p>\n

mydf <-tibble::tibble(loc=c(\"Lyon, France\",\n                            \"22 place du G\u00e9n\u00e9ral de Gaulle, Paris\",\n                            \"la Guilloti\u00e8re, Lyon\",\n                            \"Europe\",\n                            NA,\n                            \"Tucson, AZ\",\n                            \"Rio Grande do Sul\"))\n<\/code><\/pre>\n
Pour l\u2019exemple j\u2019ai choisi des lieux d\u00e9sign\u00e9s de fa\u00e7on plus ou moins vague, \u00e0 des \u00e9chelles vari\u00e9es et un peu partout dans le monde.<\/p>\n
Pour utiliser une API: montrez patte blanche!<\/h1>\n
Pour acc\u00e9der \u00e0 une API, il est la plupart du temps de s\u2019enregistrer<\/strong> aupr\u00e8s de son fournisseur afin de disposer d\u2019une cl\u00e9 d\u2019acc\u00e8s (API key)<\/strong>: une esp\u00e8ce de long mot de passe qui permet \u00e0 l\u2019API de vous identifier vous et d\u2019identifier l\u2019application pour laquelle la requ\u00eate est pass\u00e9e.<\/p>\n
Nominatim (OSM)<\/h2>\n
Pour acc\u00e9der \u00e0 cette API: bonne nouvelle! Nul besoin d\u2019une cl\u00e9 :-). L\u2019utilisation est en principe accord\u00e9e pour un usage \u201ccr\u00e9atif et inattendu\u201d\u2026 Attention n\u00e9anmoins \u00e0 utiliser le service de mani\u00e8re \u201crespectueuse\u201d (ie ne pas envoyer 2000 requ\u00eates en 5 minutes par exemple, pour ne pas surcharger les serveurs par des demandes inconsid\u00e9r\u00e9es). Plus de d\u00e9tails [ici] (https:\/\/operations.osmfoundation.org\/policies\/nominatim\/<\/a>)<\/p>\n
Google<\/h2>\n
Pour acc\u00e9der \u00e0 l\u2019API de g\u00e9ocodage de google, il faut disposer d\u2019un compte Google<\/strong> et aller r\u00e9cup\u00e9rer une cl\u00e9 pour les \u201cmaps-APIs\u201d Google ici<\/a>. Il va falloir aussi renseigner une carte de cr\u00e9dit<\/strong>, m\u00eame si vous ne pensez pas d\u00e9passer les quotas d\u2019acc\u00e8s gratuit (\u00e7a ne fait pas trop plaisir mais sans ces \u201cbilling informations\u201d la cl\u00e9 ne fonctionnera pas\u2026).<\/p>\n
La cl\u00e9 devrait ressembler \u00e0 un truc sympa du genre: \u201cBEiz89gzKNzlcpaK90ver80A_230Lli0N173kinvB\u201d (c\u2019est \u00e9videmment une fausse cl\u00e9 que j\u2019indique ici \ud83d\ude09 ).<\/p>\n
Notez que si vous disposer d\u2019une cl\u00e9 pour l\u2019API Google, cela vous permettra aussi de disposer des fonds de carte lorsque vous utilisez ggmap pour faire vos cartes (voir billet de blog ici<\/a> -billet que j\u2019avais r\u00e9dig\u00e9 \u00e0 une \u00e9poque o\u00f9 une cl\u00e9 n\u2019\u00e9tait pas encore n\u00e9cessaire pour cela-)<\/p>\n
Opencage<\/h2>\n
Pour acc\u00e9der \u00e0 l\u2019API Opencage, vous pouvez vous enregistrer ici<\/a>. Pour une utilisation ponctuelle et limit\u00e9e (2500 requ\u00eates par jour max) vous n\u2019aurez pas besoin de renseigner votre carte de cr\u00e9dit (ouf!).<\/p>\n
Votre cl\u00e9 sera un truc du genre \u201c6fjzlc8z2s6f113qx215zlk22ig1vq\u201d (encore une fois, c\u2019est une cl\u00e9 que j\u2019ai invent\u00e9e pour vous montrer l\u2019allure de la chose \ud83d\ude09 ).<\/p>\n
O\u00f9 enregistrer vos cl\u00e9s d\u2019acc\u00e8s aux API?<\/h2>\n
Si vous travaillez avec R, il y a de fortes chances que vous soyez amen\u00e9 \u00e0 partager vos scripts<\/strong> avec des collaborateurs ou m\u00eame avec le monde (via github par exemple). C\u2019est donc une mauvaise id\u00e9e d\u2019enregistrer vos cl\u00e9s dans vos scripts<\/strong> ou dans tout autre document que vous pourriez partager par inadvertance. Il vaut mieux aller les cacher dans un document aux tr\u00e9fonds de votre machine, qui vous permette d\u2019acc\u00e9der \u00e0 leurs valeurs sans risquer de les partager.<\/p>\n
Une solution pour cela consiste \u00e0 les enregistrer comme variable d\u2019environnement dans R. Pour faire cela vous pouvez faire<\/p>\n
usethis::edit_r_environ()\n<\/code><\/pre>\n
ce qui va vous ouvrir le fichier .Renviron, o\u00f9 qu\u2019il se trouve sur votre machine.<\/p>\n
Ensuite, vous taperez les lignes suivantes (avec les bonnes cl\u00e9s bien s\u00fbr) dans ce fichier:<\/p>\n
GOOGLE_KEY=\"BEiz89gzKNzlcpaK90ver80A_230Lli0N173kinvB\"\nOPENCAGE_KEY=\"6fjzlc8z2s6f113qx215zlk22ig1vq\"\n<\/code><\/pre>\n
Apr\u00e8s enregistrement de .Renviron<\/strong> et r\u00e9ouverture de R<\/strong>, vous pourrez acc\u00e9der aux valeurs de ces variables \u00e0 l\u2019aide des commandes Sys.getenv(\"GOOGLE_KEY\")<\/code> et Sys.getenv(\"OPENCAGE_KEY\")<\/code>.<\/p>\n
Comment \u00e7a fonctionne?<\/h1>\n
Les requ\u00eates envoy\u00e9es aux API ressemblent \u00e0 des URL un peu complexes de ce genre (ici pour rechercher \u201cLa Guilloti\u00e8re, Lyon\u201d aupr\u00e8s de l\u2019API de g\u00e9ocodage Google):<\/p>\n
\"https:\/\/maps.googleapis.com\/maps\/api\/geocode\/json?address=Grande+Rue+de+la+Guilloti%C3%A8re,+Lyon&key=BEiz89gzKNzlcpaK90ver80A_230Lli0N173kinvB\"\n<\/code><\/pre>\n
{Au passage, notez que \u201cURL\u201d (pour \u201cUniform Resource Locator\u201d) prend ici tout son sens\u2026<\/small><\/p>\n
On peut voir que cette URL correspond d\u2019abord \u00e0 l\u2019\u201cadresse\u201d de l\u2019API (https:\/\/maps.googleapis.com\/maps\/api\/geocode\/json<\/a>), ensuite \u00e0 la requ\u00eate elle-m\u00eame suivie du param\u00e8tre \u201ckey\u201d (address=Grande+Rue+de+la+Guilloti%C3%A8re,+Lyon&key=BEiz89gzKNzlcpaK90ver80A_230Lli0N173kinvB\u00a0\u00bb) dont la nature et les valeurs possibles sont document\u00e9es directement par le fournisseur des API :<\/p>\n