@floralink/plugin-netphyd

A Floralink plugin for retrieving occurrence data from the NetPhyD API (formerly WerBeo) and converting it to Floralink's format.

Usage

import { type ApiGroup, queryAPI } from "@floralink/core";
import netphyd from "@floralink/plugin-netphyd";

const api = netphyd.groups[0] as ApiGroup;

const query = {
  area: {
    format: "mtb",
    value: "3150/1",
  },
  period: {
    from: "1990-01-01",
    to: "1999-12-31",
  },
};

const options = {
  clientID: "...",
  portalID: 2,
};

// Use the plugin directly

const rawData = await api.getRaw(query, options);
const converted = api.convert(rawData);

// OR: Use the Floralink Core helper

const converted = queryAPI(api, query, options);

Result:

[
  {
    "id": "84cccde0-af3b-4c1e-b6fe-2ba46f22697d",
    "taxonID": "2477",
    "date": { "from": "1995-07-27", "to": "1995-07-27", "type": "DAY" },
    "survey": {
      "id": "6",
      "title": "DE-BB-Biotopkartierung",
      "description": "Import Biotopkartierung [...]"
    }
  }
  // ...
]

Portal selection

In the options argument of a getRaw query you can pass a portalID to select the portal to be queried. This defaults to Flora-MV (portalID: 5).

| portalID | Name | Regional scope | Homepage | | ---------- | -------- | ---------------------- | ------------------------------------------ | | 2 | Flora-BB | Brandenburg & Berlin | https://www.flora-bb.de | | 5 | Flora-MV | Mecklenburg-Vorpommern | https://www.flora-mv.de | | 10 | Flora-SN | Sachsen | http://sachsen-portal.infinitenature.org |

Logging in

To access all surveys from the NetPhyD API you need to call netphyd.login() and pass credentials (user and password) as argument. Be aware that, by querying the API as a signed in user, you are possibly dealing with sensitive data like exact occurrence positions or mail addresses from users.