check_api_access: Check Access to the Finna API

In finna: Access the 'Finna' API

Check Access to the Finna API

Description

This function tests whether R can successfully connect to the Finna API by downloading the OpenAPI specification from ⁠https://api.finna.fi/api/v1/?openapi⁠. It returns a logical value indicating the accessibility of the API.

Usage

check_api_access()

Value

A logical value:

• TRUE: The API is accessible.

• FALSE: The API is not accessible.

Examples

## Not run: 
  # Check if the API is accessible
  access <- check_api_access()
  if (access) {
    message("Finna API is accessible")
  } else {
    message("Finna API is not accessible")
  }

## End(Not run)

finna documentation built on April 4, 2025, 2:33 a.m.