Začínáme

Tento průvodce vám pomůže implementovat hlavní způsob použití Digitize API: import dat chráněných území a jejich průběžnou aktualizaci.

Počáteční import relevantních chráněných území

Nejprve načtěte seznam chráněných území. Pokud chcete použít celou naši datovou sadu, můžete ji získat přes:

GET /api/v2/protected-areas

Tento koncový bod vrací výchozí sadu polí a stránkovaná data. Pokud výchozí odpověď obsahuje vše potřebné, máte hotovo. Pokud potřebujete více podrobností, máte dvě možnosti:

1. Rozšiřte odpověď pomocí parametru 'fields'. Viz interaktivní dokumentace pro další informace.
2. Omezte počáteční požadavek pouze na UUID (pomocí 'fields=uuid') a poté načtěte úplné podrobnosti přes jednotlivý koncový bod: GET /api/v2/protected-areas/{uuid}
   Tento koncový bod rovněž podporuje parametr 'fields' pro přizpůsobení odpovědi.

Pokud potřebujete jen určitou podmnožinu dat, můžete použít filtry – například pro načtení pouze národních parků v Německu. Nejprve načtěte příslušná ID filtrů:

1. Získejte category_id pro národní parky (např. 1): GET /api/v2/protected-area-categories
2. Získejte country_id pro Německo (např. 1): GET /api/v2/countries
3. Použijte oba filtry pro získání cílové datové sady: GET /api/v2/protected-areas?category_id=1&country_id=1

Kontrola aktualizací nových, změněných a odstraněných území

Nová a aktualizovaná data

Chcete-li udržovat data aktuální, použijte updated_after parametr: GET /api/v2/protected-areas?updated_after=YYYY-MM-DD

Vrátí se pouze území aktualizovaná od zadaného data.

Tento parametr je podporován také u koncových bodů pro data o živé přírodě a organizacích.

Odstraněná data

Pro sledování odstranění použijte vyhrazený koncový bod: GET /api/v2/protected-areas/deleted
Podle konkrétního data můžete filtrovat pomocí: GET /api/v2/protected-areas/deleted?date=YYYY-MM-DD (vrací odstranění po zadaném datu; pro zahrnutí odstranění z tohoto dne použijte předchozí den).

Specifika synchronizace uzavírek a upozornění

Pro GET /api/v2/closures-and-notices začněte jednorázovým načtením všech záznamů relevantních pro vaši aplikaci. Parametrem fields určete pole zahrnutá v odpovědi a zmenšete objem dat.

Seznamový koncový bod ve výchozím stavu vrací aktuální a nadcházející záznamy. Pokud má počáteční synchronizace zahrnovat i ukončené záznamy, přidejte odpovídající filtry data nebo stavu.

GET /api/v2/closures-and-notices?fields=uuid,name,type,reason_id,start_on,end_on,daytime_start,daytime_end,activity_ids,source_id

Pro pozdější přírůstkové synchronizace vyžádejte záznamy změněné od poslední úspěšné synchronizace. Použijte parametr updated_after: GET /api/v2/closures-and-notices?updated_after=YYYY-MM-DD

Pokud záznamy ukládáte lokálně, měli byste sami vypočítat jejich stav – aktuální, nadcházející nebo ukončený – z polí start_on, end_on, daytime_start a daytime_end. Respektujte příslušná pravidla místního data a času.

Uživatelé, kteří nechtějí sami vypočítávat stav, mohou použít serverové filtry active_on, status, filtry období starts_after, starts_before, ends_after a ends_before a také bbox, type, source_id, source_kind, activity_id a reason_id.

Další tipy

• Použijte filtrování polí (např. ?fields=id,name,geometry pro zmenšení objemu dat a zlepšení výkonu.
• Dodržujte přiměřené využívání: přestože nevynucujeme přísné limity počtu požadavků, žádáme všechny uživatele o odpovědné používání bez nadměrného zatěžování nebo zneužívání.
• Sledujte seznam změn pro změny schématu a aktualizace verzí.

Máte-li dotazy nebo potřebujete podporu, kdykoli nás kontaktujte.