cebrap.lab online - Raspagem de dados com R

Conhecendo API’s

Beatriz Milz

outubro de 2024

O que é API?

• Application Programming Interface.

• É uma forma unificada para acessar dados de uma plataforma, a partir de qualquer linguagem de programação.

• Facilita a vida da pessoa que programa.

• Geralmente vem acompanhada de documentação.

• Reduz o volume na transferência de dados

API

Como funciona uma API?

1. Acessar

• Instruções de acesso na documentação da API.
• Pode envolver obter um token de acesso, que funciona como uma senha.

2. Coletar

• Geralmente são requisições do tipo GET.
• Pode ou não possuir parâmetros para acessar as informações.
• O resultado geralmente vem num arquivo json.

Como funciona uma API?

3. Inserir

• Geralmente são requisições do tipo POST.
• Necessariamente possui parâmetros para enviar informações ao servidor.

Pacotes

• R: httr ou httr2.

Tipos de APIs

• APIs disponíveis/documentadas: O site fornece uma forma estruturada e documentada para acessar as páginas (com ou sem necessidade de fazer login).

• APIs escondidas: O site não fornece uma forma estruturada e documentada para acessar as páginas, mas internamente é alimentado por uma API não documentada, que podemos descobrir e usar.

Requisições

• GET: Requisição para obter dados.

• POST: Requisição que permite envio de dados (ex. parâmetros para autenticação).

Exemplo - Brasil API

https://brasilapi.com.br

Documentação

https://brasilapi.com.br/docs#tag/CEP

Compondo uma requisição

• Precisamos descobrir qual URL acessar.

Buscando um CEP no R

url_base <- "https://brasilapi.com.br/api" 
endpoint <- "/cep/v1/"
query_parameters <- "01310100"
u_brasilapi <- paste0(url_base, endpoint, query_parameters) 
u_brasilapi

[1] "https://brasilapi.com.br/api/cep/v1/01310100"

httr::GET(u_brasilapi)

Response [https://brasilapi.com.br/api/cep/v1/01310100]
  Date: 2024-10-20 20:31
  Status: 200
  Content-Type: application/json; charset=utf-8
  Size: 128 B

Possíveis status

• 200 OK

• 302 Redirecionado

• 400 Requisição mal formatada

• 401 Não autorizado

• 404 Não encontrado

• 503 Erro no servidor

JSON

Acesse: https://brasilapi.com.br/api/cep/v1/01310100

Vamos ao R:
scripts/01-api-documentada.R

APIs escondidas

APIs escondidas

• Uma API “escondida” é uma API que não é documentada, mas que é usada internamente por um site.

• Neste caso, podemos descobrir sua existência explorando.

• Técnicas mais importantes:

  • Inspecionar elemento

  • Aba Network

Exemplo - Sabesp

1. Abra o navegador
2. Acesse o Portal de Mananciais da Sabesp: http://mananciais.sabesp.com.br/
3. Vamos explorar o inspetor de elementos e a aba Network!

Vamos ao R:
scripts/02-api-escondida.R

Autenticação

GET e POST

• GET utiliza parâmetros na URL
  • Utilizar parâmetro query=
• POST utiliza parâmetros no corpo da requisição
  • Utilizar o parâmetro body=
  • Pode utilizar parâmetros na URL, mas não é comum
• A principal diferença entre os dois tipos é a segurança

Autenticação

• A autenticação é usada tanto em APIs quanto sites.

• Geralmente acontece através de um parâmetro em uma requisição POST.

• A requisição pode aparecer no body ou nos headers.

• Se a API for documentada, as informações de autenticação estarão lá.

Vamos ao R:
scripts/03-api-autenticacao.R