API lokalít

Správa poštových smerovacích čísel a územných údajov

Základná URL

https://{tenant}.logzi.com/api/locales/

Každá požiadavka vracia odpoveď vo formáte JSON. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0. API lokalít slúži na správu databázy poštových smerovacích čísel a názvov obcí, ktorá je potrebná na vypĺňanie adries partnerov a miest doručenia.

GET /api/locales/get

Získanie jedného záznamu lokality.

Query parametre

ParameterTypPovinnéPopis
idintIdentifikátor záznamu
zipstringPoštové smerovacie číslo na filtrovanie
country_idintIdentifikátor krajiny na filtrovanie

Príklad požiadavky

GET /api/locales/get?zip=1011&country_id=1
X-API-KEY: {vas_api_kluc}
GET /api/locales/list

Získanie zoznamu záznamov lokalít.

Nie je potrebný žiadny parameter.

Príklad požiadavky

GET /api/locales/list
X-API-KEY: {vas_api_kluc}
POST /api/locales/save

Vytvorenie alebo úprava záznamu lokality.

POST polia — objekt data

V objekte data je potrebné uviesť údaje záznamu PSČ (poštové smerovacie číslo, názov obce, identifikátor krajiny).

Príklad požiadavky

POST /api/locales/save
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{ "data": { "id": 1 } }
POST /api/locales/delete

Odstránenie záznamu lokality.

POST polia — objekt data

V objekte data je potrebné uviesť údaje záznamu, ktorý sa má odstrániť.

Príklad požiadavky

POST /api/locales/delete
X-API-KEY: {vas_api_kluc}
Content-Type: application/json

{ "data": { "id": 1 } }

Kontaktuj nás

Zaujíma ťa náš softvér? Pokojne nám napíš!

Potrebuješ pomoc?

Ak nevieš nájsť odpoveď a potrebuješ pomoc

Zaregistruj sa teraz,
zaplať neskôr!

Vyskúšaj 3 dni zadarmo, bez rizika a záväzkov!