check_api_access: Check Access to Statistics Finland Geoserver APIs

In geofi: Access Finnish Geospatial Data

Check Access to Statistics Finland Geoserver APIs

Description

Tests whether R can access resources at Statistics Finland's geoserver APIs, specifically the WFS (Web Feature Service) or OGC API. This internal function is used to verify connectivity before making API requests.

Usage

check_api_access(which_api = "statfi_wfs")

Arguments

which_api

Character. The API to check. Must be one of: "statfi_wfs" (checks WFS at http://geo.stat.fi/geoserver/wfs) or "statfi_ogc" (checks OGC API at https://geo.stat.fi/inspire/ogc/api/su/). Defaults to "statfi_wfs".

Details

This function sends a lightweight HTTP request to the specified API endpoint to check for accessibility. It uses httr2 for robust HTTP handling and retries transient network failures up to 3 times. The function is intended for internal use within the package to ensure API connectivity before executing data retrieval operations.

Value

Logical. Returns TRUE if the API is accessible (HTTP status 200), FALSE otherwise. Issues a warning if the request fails due to network issues or non-200 status codes.

Author(s)

Markus Kainu [e-mail]

Examples

## Not run: 
  check_api_access()  # Check WFS API
  check_api_access("statfi_ogc")  # Check OGC API

## End(Not run)

geofi documentation built on June 8, 2025, 9:32 p.m.