Glossary
# API
Application programming interface. In the context of a web service like FHAB API, a web protocol that allows for communication with and data retrieval through the internet. Here, FHAB API defines HTTP-based routes and endpoints that can be called to access data from the FHAB database and even run some basic raster analyses.
# Composite
A raster that is composited from multiple rasters. Here, we define composites as the statistical summaries of multiple dates and observations. E.g. the 10-day maximum composite is the maximum, valid pixel value observed in any imagery captured over the last ten days. This is differentiated from mosaics in that mosaics are composed only of a single observation (there may be multiple mosaics for a given day, depending on observations made between different satellites).
# CSV
Comma-separated values. A text file format for storing tabular data, using commas to separate each record and newlines to separate new rows.
# Endpoint
An API endpoint is mostly synonymous with API routes, but includes the HTTP request method used to make the request (e.g. GET or POST) such that a route can have one or more endpoints.
# FHAB
Freshwater harmful algal blooms. Which include toxin-producing cyanobacteria.
# GET
A type of HTTP request method where data related to the request are encoded entirely within the URL. Contrasted with POST requests, which can encode data in the request body.
# JSON
JavaScript Object Notation. A human-readable, JavaScript-based, text format for representing and interchanging data.
# Mosaic
A raster composed of the two or more merged rasters. Here, we differentiate mosaics from composites, in that mosaics are composed only of observations from the same day, where as composites can be composed of multiple dates.
# POST
A type of HTTP request method where data related to the request can be encoded in the request body. Contrasted with GET requests, which can only encode data in the URL.
Though POST requests have an additional meaning in strictly RESTful APIs, here POST requests are simply utilized for their ability to encode data in the request body.
# Raster
A data format consisting of a grid of cells/pixels in rows and columns, representing an image and/or surface.
# Request
A message sent from the user or client to the API service. All interactions between the user and API begin with a request from the user to the API.
# Response
The response from an HTTP request. If successful, the payload is the returned data that was being requested. If an error, the response will have information about the error.
# Route
A route is a specific URL path that can be called upon to open a line of communication with the API and perform some service (e.g. data retrieval). Somewhat synonymous with endpoints, though a route can contain one or more endpoints.
# URL
Uniform resource locator, or web address.