pa_checkAPIKey: Check the validity and type for the provided 'api_key'.

In MazamaScience/AirSensor: Process and Display Data from Air Quality Sensors

Check the validity and type for the provided api_key.

Description

Sends a request to the PurpleAirAPI API endpoint described at: https://api.purpleair.com/#api-keys-check-api-key

Usage

pa_checkAPIKey(api_key = NULL, baseUrl = "https://api.purpleair.com/v1/keys")

Arguments

api_key	PurpleAir API key.
baseUrl	URL endpoint for the "Check Key" API.

Value

List containing key type information.

Examples

# Fail gracefully if any resources are not available
try({

library(AirSensor)

  pa_checkAPIKey(
    api_key = PURPLE_AIR_API_READ_KEY
  )

}, silent = FALSE)

MazamaScience/AirSensor documentation built on April 28, 2023, 11:16 a.m.