Uma das grandes vantagens de utilizar APIs \u00e9 que ela n\u00e3o depende de uma linguagem de programa\u00e7\u00e3o, faremos uma requisi\u00e7\u00e3o a uma URL<\/em>, que nos retornar\u00e1 uma resposta. Apesar disso, todos os exemplos que mostrarei aqui, utilizam a linguagem R<\/a>. <\/p>\n\n\n\n Antes de exemplificar como podemos acessar e criar uma API no R, vamos entender algumas coisas relacionadas a API de forma geral.<\/p>\n\n\n\n O endpoint \u00e9 uma URL<\/em>, um caminho, onde iremos fazer uma requisi\u00e7\u00e3o e que possui a seguinte estrutura.<\/p>\n\n\n\n Os m\u00e9todos nos ajudam a informar o tipo de a\u00e7\u00e3o que queremos fazer no momento da requisi\u00e7\u00e3o e esses s\u00e3o os principais m\u00e9todos existentes:<\/p>\n\n\n\n HTTP ou do ingl\u00eas “Hyper Text Transfer Protocol” \u00e9 um protocolo de comunica\u00e7\u00e3o de dados da internet. Onde existem padr\u00f5es de c\u00f3digos de status, que facilitam o entendimento das respostas das APIs.<\/p>\n\n\n\n Os c\u00f3digos de respostas mais utilizados s\u00e3o:<\/p>\n\n\n\n Veremos como acessar uma API no R, caso essa API n\u00e3o tenha um pacote criado, pois o R possui alguns pacotes que permitem acessarmos algumas APIs espec\u00edficas, como o rtweet<\/a>, que permite acessar a API do Twitter. Mas para exemplificar, veremos como utilizar uma API caso ela n\u00e3o tenha nenhum pacote j\u00e1 criado e nessa situa\u00e7\u00e3o precisaremos instalar e carregar alguns pacotes essenciais para essa tarefa: Instalando os pacotes utilizando a fun\u00e7\u00e3o Agora que instalamos e carregamos os pacotes necess\u00e1rios para acessar uma API, vamos iniciar as requisi\u00e7\u00f5es e, como primeiro exemplo, iremos acessar uma API onde \u00e9 poss\u00edvel solicitar v\u00e1rias informa\u00e7\u00f5es relacionadas ao COVID-19<\/a>.<\/p>\n\n\n\n Nesta API que acabamos de acessar, n\u00e3o foi necess\u00e1rio realizar nenhuma autentica\u00e7\u00e3o, por\u00e9m agora mostrarei um exemplo da API do AccuWeather<\/a> que para ter acesso aos dados \u00e9 necess\u00e1rio utilizar uma chave<\/strong>, que \u00e9 disponibilizada ap\u00f3s fazer o cadastro no site.<\/p>\n\n\n\n E outra forma de autentica\u00e7\u00e3o, \u00e9 atrav\u00e9s de um usu\u00e1rio e uma senha, por\u00e9m n\u00e3o encontrei nenhuma API para mostrar, mas caso voc\u00ea se encontre nessa situa\u00e7\u00e3o \u00e9 bem simples o processo, segue abaixo o exemplo:<\/p>\n\n\n\n Gostou do nosso artigo? Se quiser se aprofundar mais nesse assunto indicamos o guia completo de APIs RESTFUL<\/a> e o Tutorial: Construindo APIs<\/a>. E siga-nos nas redes sociais para saber sempre que publicamos um novo artigo. <\/p>\n","protected":false},"excerpt":{"rendered":" Existem v\u00e1rias formas de se obter os dados, que s\u00e3o a mat\u00e9ria prima da ci\u00eancia de dados, mas as API v\u00eam se tornando uma das formas mais comuns. <\/p>\n","protected":false},"author":8,"featured_media":6806,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"site-sidebar-layout":"","site-content-layout":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","spay_email":"","footnotes":""},"categories":[445],"tags":[235,249,250,251,176],"class_list":["post-6796","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-ferramentas-e-tecnologias","tag-rstats","tag-accuweather","tag-apis","tag-covid-19","tag-linguagem-r"],"yoast_head":"\n![\"\"](\"https:\/\/i1.wp.com\/operdata.com.br\/wp-content\/uploads\/2020\/07\/artigo-corpo-26.jpg?fit=1030%2C618&ssl=1\")
<\/figure><\/div>\n\n\n\nEndpoint<\/h2>\n\n\n\n
Ex.:<\/em> https:\/\/api.covid19api.com\/<\/code><\/li>
Ex.:<\/em> https:\/\/api.covid19api.com\/country\/brazil\/status\/confirmed<\/code><\/li>
Ex.:<\/em> https:\/\/api.covid19api.com\/country\/brazil\/status\/confirmed&from=2020-06-01T00:00:00Z&to=2020-07-07T00:00:00Z<\/code><\/li><\/ul>\n\n\n\n![\"url](\"https:\/\/statplace.com.br\/wp-content\/uploads\/2020\/07\/base_url-1030x131.png\")
<\/figure><\/div>\n\n\n\nM\u00e9todos<\/h2>\n\n\n\n
C\u00f3digo de status HTTP<\/h2>\n\n\n\n
Acessando API<\/h2>\n\n\n\n
httr<\/code> e jsonlite<\/code>.<\/p>\n\n\n\ninstall.packages()<\/code>, caso n\u00e3o o tenha instalado em seu computador e carregando os pacotes utilizando a fun\u00e7\u00e3o library()<\/code>.<\/p>\n\n\n\n# Instalando os pacotes\ninstall.packages(c(\"httr\", \"jsonlite\"))\n\n# Carregando os pacotes\nlibrary(httr)\nlibrary(jsonlite)<\/code><\/pre>\n\n\n\n# Separando a estrutura do endpoint 'endere\u00e7o' que iremos acessar, em vari\u00e1veis\nbase_url <- \"https:\/\/api.covid19api.com\"\npath <- \"country\/brazil\/status\/confirmed\"\n\nendpoint <- paste(base_url, path, sep=\"\/\")\n\n# Fazendo uma solita\u00e7\u00e3o GET a API, passando o endere\u00e7o da requisi\u00e7\u00e3o e o query string,\n# que s\u00e3o par\u00e2metros que segundo a documenta\u00e7\u00e3o da API esse endpoint pode receber\nres_api <- GET(\n url = endpoint, \n query = list(\n from = \"2020-06-20T00:00:00Z\",\n to = \"2020-07-07T00:00:00Z\"\n )\n)\n\n# Visualizando a resposta da requisi\u00e7\u00e3o\nres_api<\/code><\/pre>\n\n\n\n## Response [https:\/\/api.covid19api.com\/country\/brazil\/status\/confirmed?from=2020-06-20T00%3A00%3A00Z&to=2020-07-07T00%3A00%3A00Z]\n## Date: 2020-07-09 00:53\n## Status: 200\n## Content-Type: application\/json; charset=UTF-8\n## Size: 3.15 kB\n## [{\"Country\":\"Brazil\",\"CountryCode\":\"BR\",\"Province\":\"\",\"City\":\"\",\"CityCode\":\"\"...<\/code><\/pre>\n\n\n\n# Nesse momento os nossos dados da requisi\u00e7\u00e3o est\u00e3o contidos em um Unicode bruto,\n# sendo necess\u00e1rio converter seu conte\u00fado para um vetor de caracteres\ncontent_text <- rawToChar(res_api$content)\n\n# Visualizando o resultado da convers\u00e3o, que ser\u00e1 uma estrutura JSON no formato caractere\ncontent_text<\/code><\/pre>\n\n\n\n# Convertendo a estrutura JSON no formato caratere para um objeto do R\ncontent_json <- fromJSON(content_text, flatten=TRUE)\n\n# Visualizando o resultado da convers\u00e3o\ncontent_json<\/code><\/pre>\n\n\n\n## Country CountryCode Province City CityCode Lat Lon Cases Status Date\n## 1 Brazil BR -14.24 -51.93 1067579 confirmed 2020-06-20T00:00:00Z\n## 2 Brazil BR -14.24 -51.93 1083341 confirmed 2020-06-21T00:00:00Z\n## 3 Brazil BR -14.24 -51.93 1106470 confirmed 2020-06-22T00:00:00Z\n## 4 Brazil BR -14.24 -51.93 1145906 confirmed 2020-06-23T00:00:00Z\n## 5 Brazil BR -14.24 -51.93 1188631 confirmed 2020-06-24T00:00:00Z\n## 6 Brazil BR -14.24 -51.93 1228114 confirmed 2020-06-25T00:00:00Z\n## 7 Brazil BR -14.24 -51.93 1274974 confirmed 2020-06-27T00:00:00Z\n## 8 Brazil BR -14.24 -51.93 1313667 confirmed 2020-06-28T00:00:00Z\n## 9 Brazil BR -14.24 -51.93 1344143 confirmed 2020-06-29T00:00:00Z\n## 10 Brazil BR -14.24 -51.93 1368195 confirmed 2020-06-30T00:00:00Z\n## 11 Brazil BR -14.24 -51.93 1402041 confirmed 2020-07-01T00:00:00Z\n## 12 Brazil BR -14.24 -51.93 1448753 confirmed 2020-07-02T00:00:00Z\n## 13 Brazil BR -14.24 -51.93 1496858 confirmed 2020-07-03T00:00:00Z\n## 14 Brazil BR -14.24 -51.93 1539081 confirmed 2020-07-04T00:00:00Z\n## 15 Brazil BR -14.24 -51.93 1577004 confirmed 2020-07-05T00:00:00Z\n## 16 Brazil BR -14.24 -51.93 1603055 confirmed 2020-07-06T00:00:00Z\n## 17 Brazil BR -14.24 -51.93 1623284 confirmed 2020-07-07T00:00:00Z\n## 18 Brazil BR -14.24 -51.93 1668589 confirmed 2020-07-08T00:00:00Z\n<\/code><\/pre>\n\n\n\n# Separando a estrutura do endpoint 'endere\u00e7o' que iremos acessar, em vari\u00e1veis\nbase_url <- \"http:\/\/dataservice.accuweather.com\"\npath <- \"locations\/v1\/regions\"\n\nendpoint <- paste(base_url, path, sep=\"\/\")\n\n# Atribuindo o token a uma vari\u00e1vel de ambiente do R\n# 1\u00b0 op\u00e7\u00e3o: Ser\u00e1 aberto um arquivo com todas as vari\u00e1veis de ambiente e voc\u00ea poder\u00e1 adicionar uma nova\n#usethis::edit_r_environ()\n# 2\u00b0 op\u00e7\u00e3o: Cria uma vari\u00e1vel, sem a necessidade de abrir o arquivo\n#Sys.setenv(\"KEY_API\" = \"sua_api\")\n\n# Obtendo a vari\u00e1vel de ambiente e atribuindo a uma nova vari\u00e1vel\nkey_api <- Sys.getenv(\"KEY_API\")\n\n# Fazendo uma solita\u00e7\u00e3o GET a API, passando o endere\u00e7o da requisi\u00e7\u00e3o e o query string,\n# que neste caso, ser\u00e1 a chave e que queremos os detalhes\nres_api <- GET(\n url = endpoint, \n query = list(\n apikey= key_api,\n details = \"true\"\n )\n)\n\n# Visualizando o resposta da requisi\u00e7\u00e3o\nres_api<\/code><\/pre>\n\n\n\n## Response [http:\/\/dataservice.accuweather.com\/locations\/v1\/regions?apikey=GFElrX6oceGWX12S9dMppSaijYXjSC1p&details=true]\n## Date: 2020-07-09 00:53\n## Status: 200\n## Content-Type: application\/json; charset=utf-8\n## Size: 673 B<\/code><\/pre>\n\n\n\n# Nesse momento os nossos dados da requisi\u00e7\u00e3o est\u00e3o contidos em um Unicode bruto,\n# sendo necess\u00e1rio converter seu conte\u00fado para um vetor de caracteres\ncontent_text <- rawToChar(res_api$content)\n\n# Visualizando o resultado da convers\u00e3o, que ser\u00e1 uma estrutura JSON no formato caractere\ncontent_text<\/code><\/pre>\n\n\n\n## [1] \"[{\\\"ID\\\":\\\"AFR\\\",\\\"LocalizedName\\\":\\\"Africa\\\",\\\"EnglishName\\\":\\\"Africa\\\"},{\\\"ID\\\":\\\"ANT\\\",\\\"LocalizedName\\\":\\\"Antarctica\\\",\\\"EnglishName\\\":\\\"Antarctica\\\"},{\\\"ID\\\":\\\"ARC\\\",\\\"LocalizedName\\\":\\\"Arctic\\\",\\\"EnglishName\\\":\\\"Arctic\\\"},{\\\"ID\\\":\\\"ASI\\\",\\\"LocalizedName\\\":\\\"Asia\\\",\\\"EnglishName\\\":\\\"Asia\\\"},{\\\"ID\\\":\\\"CAC\\\",\\\"LocalizedName\\\":\\\"Central America\\\",\\\"EnglishName\\\":\\\"Central America\\\"},{\\\"ID\\\":\\\"EUR\\\",\\\"LocalizedName\\\":\\\"Europe\\\",\\\"EnglishName\\\":\\\"Europe\\\"},{\\\"ID\\\":\\\"MEA\\\",\\\"LocalizedName\\\":\\\"Middle East\\\",\\\"EnglishName\\\":\\\"Middle East\\\"},{\\\"ID\\\":\\\"NAM\\\",\\\"LocalizedName\\\":\\\"North America\\\",\\\"EnglishName\\\":\\\"North America\\\"},{\\\"ID\\\":\\\"OCN\\\",\\\"LocalizedName\\\":\\\"Oceania\\\",\\\"EnglishName\\\":\\\"Oceania\\\"},{\\\"ID\\\":\\\"SAM\\\",\\\"LocalizedName\\\":\\\"South America\\\",\\\"EnglishName\\\":\\\"South America\\\"}]\"<\/code><\/pre>\n\n\n\n# Convertendo a estrutura JSON no formato caratere para um objeto do R\ncontent_json <- fromJSON(content_text, flatten=TRUE)\n\n# Visualizando o resultado da convers\u00e3o\ncontent_json<\/code><\/pre>\n\n\n\n## ID LocalizedName EnglishName\n## 1 AFR Africa Africa\n## 2 ANT Antarctica Antarctica\n## 3 ARC Arctic Arctic\n## 4 ASI Asia Asia\n## 5 CAC Central America Central America\n## 6 EUR Europe Europe\n## 7 MEA Middle East Middle East\n## 8 NAM North America North America\n## 9 OCN Oceania Oceania\n## 10 SAM South America South America<\/code><\/pre>\n\n\n\nuser <- \"usuario_para_acesso_api\"\npassword <- \"senha\"\n\nendpoint <- \"http:\/\/api.endereco.com\"\n\nreq <- GET(\n url = endpoint, \n authenticate(\n user, \n password, \n type = \"basic\"\n )\n)<\/code><\/pre>\n\n\n\n