Client: The Hakai API Client Class

In hakaiApi: Authenticated HTTP Request Client for the 'Hakai' API

The Hakai API Client Class

Description

Class to use to make authenticated API requests for Hakai data

Public fields

api_root

The api_root you are logged in to

Methods

Public methods

• Client$new()

• Client$get()

• Client$post()

• Client$put()

• Client$patch()

• Client$remove_credentials()

• Client$clone()

---

Method new()

Log into Google to gain credential access to the API

Usage

Client$new(
  api_root = "https://hecate.hakai.org/api",
  login_page = "https://hecate.hakai.org/api-client-login"
)

Arguments

api_root

Optional API base url to fetch data. Defaults to "https://hecate.hakai.org/api"

login_page

Optional API login page url to display to user. Defaults to "https://hecate.hakai.org/api-client-login"

Returns

A client instance

Examples

try(
   client <- Client$new()
)

---

Method get()

Send a GET request to the API

Usage

Client$get(endpoint_url, col_types = NULL)

Arguments

endpoint_url

The full API url to fetch data from

col_types

a readr type specification

Returns

A dataframe of the requested data

Examples

try(client$get("https://hecate.hakai.org/api/aco/views/projects"))

---

Method post()

Send a POST request to the API

Usage

Client$post(endpoint_url, rec_data)

Arguments

endpoint_url

The full API url to fetch data from

rec_data

dataframe, list, or other R data structure to send as part of the post request payload

Returns

post request response status code and description

---

Method put()

Send a PUT request to the API

Usage

Client$put(endpoint_url, rec_data)

Arguments

endpoint_url

The full API url to fetch data from

rec_data

dataframe, list, or other R data structure to send as part of the post request payload

Returns

PUT request response status code and description

---

Method patch()

Send a PATCH request to the API

Usage

Client$patch(endpoint_url, rec_data)

Arguments

endpoint_url

The full API url to fetch data from

rec_data

dataframe, list, or other R data structure to send as part of the post request payload

Returns

PATCH request response status code and description

---

Method remove_credentials()

Remove your cached login credentials to logout of the client

Usage

Client$remove_credentials()

Examples

try(
   client$remove_credentials()
)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Client$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
# Initialize a new client
try(
  client <- Client$new()
)

# Follow authorization prompts to log in

# Retrieve some data. See <https://hakaiinstitute.github.io/hakai-api/> for options.
try(
  url <- paste0(client$api_root, "/aco/views/projects?project_year=2020&fields=project_name")
)

try(
  projects_2020 <- client$get(url)
)

try(
  print(projects_2020)
)
# # A tibble: 20 x 1
#    project_name
#    <chr>
#  1 Fountain FN
#  2 Haig Glacier
#  3 Fraser River - Chimney Creek West William Canyon
#  4 Cruickshank WS
#  ...

## End(Not run)

## ------------------------------------------------
## Method `Client$new`
## ------------------------------------------------

try(
   client <- Client$new()
)

## ------------------------------------------------
## Method `Client$get`
## ------------------------------------------------

try(client$get("https://hecate.hakai.org/api/aco/views/projects"))

## ------------------------------------------------
## Method `Client$remove_credentials`
## ------------------------------------------------

try(
   client$remove_credentials()
)

hakaiApi documentation built on June 8, 2025, 1:50 p.m.