InternetLocAPI

Soukromé API které slouží k zjištění připojitelnosti budovy přes Optické trasy Faster CZ.

• Komunikace probíhá přes HTTPS
• Klient posílá POST s JSON payloadem a obdrží výsledek jako JSON
• Jedná se o soukromé API - je třeba mít API klíč

Výsledek jsou dvě hodnoty: pripojitelnost a vzdalenost.

pripojitelnost říká jestli a případně jak je možné hledanou lokalitu připojit. Možné hodnoty jsou:

1. Nedostupné (nelze připojit)
2. Dostupné (pravděpodobně samotný přípojný bod)
3. Dostupné - optický spoj v objektu (neměl by být problém připojit optikou)
4. Dostupné - optický spoj v dosahu (mělo by být možné připojit optikou)
5. Dostupné - radiový spoj v objektu (nelze připojit přes optiku ale bezdrátové připojení by neměl být problém)
6. Dostupné - radiový spoj v dosahu (mělo by být možné připojit přes bezdrátové připojení)

vzdalenost slouží k debugování a říká vzdálenost hledané oblasti od nejbližšího přípojného bodu.

Příklad odpovědi:

{
   "pripojitelnost": 2,
   "vzdalenost": 0.095
}

Slouží k jednoduchému hledání, do hodnoty „name“ můžete vložit libovolné údaje a na základě nich dostanete výsledek.

Informace z tohoto endpointu mohou být nepřesné (například pokud dvě obce mají stejný název ulice a uživatel nespecifikuje město)

Příklad JSON:

{
   "name":"Jarní 1064/44g",
   "apikey":"yourapikey"
}

Slouží k hledání pokud máte všechny dané informace.

Informace z tohoto endpointu jsou přesné pokud vyplníte dané informace správně.

Příklad JSON:

{
   "street":"Jarní",
   "city":"Brno",
   "housenumber":"1064/44",
   "county":"Jihomoravský kraj",
   "country":"CZ",
   "apikey":"yourapikey"
}

Slouží k hledání pokud máte adresu v zeměpisných souřadnicích (geographic coordinate system (GCS)).

Informace z tohoto endpointu jsou přesné a pokud máte adresu v tomto formátu je to preferovaný způsob pro dotazy.

Příklad JSON:

{
   "lat":49.1979883,
   "lon":16.6145102,
   "apikey":"yourapikey"
}

Slouží k hledání podle ID v Registru územní identifikace, adres a nemovitostí (RÚIAN).

Informace z tohoto endpointu jsou přesné a pokud máte adresu v tomto formátu.

Příklad JSON:

{
   "id":42667887,
   "apikey":"yourapikey"
}

curl -X POST -H "Content-Type: application/json" -d '{"lat":49.1979883,"lon":16.6145102,"apikey":"yourapikey"}' 'https://internetlocapi.faster.cz/gcs'

Chyby vrací pod různými kódy hodnota „chyba“ v odpovědi.

Příklad chyby:

{
   "chyba":1
}

1. Špatný API klíč
2. Nenalezený objekt