fogocruzado_signin: Retrieve a Fogo Cruzado's API token

In voltdatalab/crossfire: Extract data of Fogo Cruzado's repository of shootings in Brazil

Retrieve a Fogo Cruzado's API token

Description

Sets Fogo Cruzado's user and password for the current R session, in order to require a token to use its API. See the details section for more information.

Usage

fogocruzado_signin(email, password)

Arguments

email	e-mail which was registered to access Fogo Cruzado's API.
password	password which was registered to access Fogo Cruzado's API.

Details

Fogo Cruzado's API (https://api.fogocruzado.org.br/) allows easier access to Fogo Cruzado's data from shootings and fire gun shots recorded in Brazil. The API requires a token to be used. This token expires within an hour, after which it needs to be refreshed. Only registered users can require a token in the API. To register, users should access: https://api.fogocruzado.org.br/register.

Once users are registered and have authorized access, they need to request a token to extract data using the API. This can be done using fogocruzado_signin function. Fogo Cruzado uses a JWT authentication standard to grant users access to the API.

fogocruzado_signin function sets the API user (e-mail) and password only for the current R session. However, since the user and password are personal and private, we recommend a careful use of this function in R script files, so that users do not share these information.

Value

Sets "FOGO_CRUZADO_EMAIL", "FOGO_CRUZADO_PASSWORD" and "FOGO_CRUZADO_API_TOKEN" as environment variables.

Author(s)

The function design was inspired by the register_google() function, from the ggmap package.

Examples

# this sets your email and password for the current session and retrieves a
# Bearer token that lasts for 1 hour. If the current token is expired, this
# function uses the information previously set to retrieve a new one.

## Not run: 
fogocruzado_signin(email = "[e-mail]", password = "yourpassword")

## End(Not run)

voltdatalab/crossfire documentation built on Oct. 30, 2023, 7:11 p.m.