Autoform

Integračný manuál


Jednoduchá integrácia pomocou JavaScriptu alebo priamo cez API.

JavaScript integrácia

Ukážka

<script src="https://code.jquery.com/jquery-1.10.2.js"></script>
<script src="https://code.jquery.com/ui/1.11.4/jquery-ui.js"></script>
      <script async src="https://autoform.ekosystem.slovensko.digital/assets/autoform.js"></script>

<form data-slovensko-digital-autoform="SEM_JAVASCRIPT_KĽÚČ" action="...">
  <p>
    <label for="name">Názov</label><br>
    <input type="text" name="name" data-slovensko-digital-autoform="name"/>
  </p>
  <p>
    <label for="cin">IČO</label><br>
    <input type="text" name="cin" data-slovensko-digital-autoform="cin"/>
  </p>
  <p>
    <label for="formatted_address">Adresa</label><br>
    <input type="text" name="formatted_address" data-slovensko-digital-autoform="formatted-address"/>
  </p>
  <p>
    <label for="tin">DIČ</label><br>
    <input type="text" name="tin" data-slovensko-digital-autoform="tin"/>
  </p>
  <p>
    <label for="vatin">IČ-DPH</label><br>
    <input type="text" name="vatin" data-slovensko-digital-autoform="vatin"/>
  </p>
</form>

Postup integrácie

  1. Pre integráciu do HTML formulára je potrebné použiť knižnice jQuery, jQuery UI a Autoform.

  2. Element <form> je potrebné označiť atribútom data-slovensko-digital-autoform s API klúčom udeleným pri registrácii.

  3. Následne stačí jednotlivé prvky formulára označiť atribútmi data-slovensko-digital-autoform určujúcimi typ údajov.

    Hodnota atribútu Typ Význam Ukážka hodnoty
    id integer Unikátny identifikátor záznamu 1532254
    name string Názov subjektu "Websupport, s.r.o."
    cin string IČO "36 421 928"
    formatted-address string Naformátovaná adresa "Staré Grunty 12, 841 04 Bratislava"
    street string Ulica "Staré Grunty"
    building-number string Orientačné číslo "12"
    reg-number integer Súpisné číslo null
    street-number string Číslo domu "12"
    formatted-street string Ulica a číslo "Staré Grunty 12"
    postal-code string PSČ "841 04"
    municipality string Obec "Bratislava"
    country string Krajina "Slovenská republika"
    tin integer DIČ 2021869234
    vatin string IČ-DPH "SK2021869234"
    vatin-paragraph string DPH podľa paragrafu "§4"
    registration-office string Registrátor "Okresný súd Bratislava I"
    registration-number string Registračné číslo "Sro/63270/B"
    legal-form string Právna forma "Združenie (zväz, spolok, spoločnosť, klub ai.)"
    established-on string Dátum vzniku "2004-08-12"
    terminated-on string Dátum zániku null
    main-economic-activity.code string Kód hlavných ekonomických činností "63110"
    main-economic-activity.name string Názov klasifikácie hlavných ekonomických činností "Spracovanie dát, poskytovanie serverového priestoru na internete a súvisiace služby"
    statutory.type string Typ štatutárneho orgánu "Konateľ"
    statutory.first_name string Meno štatutárneho orgánu "Sara Maria"
    statutory.last_name string Priezvisko štatutárneho orgánu "Laurell"
    statutory.prefixes string Tituly pred menom štatutárneho orgánu ""
    statutory.postfixes string Tituly za menom štatutárneho orgánu ""
    statutory.formatted_name string Plné formátované meno štatutárneho orgánu "Sara Maria Laurell"
    statutory.street string Ulica bydliska štatutárneho orgánu "Karlavägen"
    statutory.reg_number integer Súpisné číslo bydliska štatutárneho orgánu null
    statutory.building_number string Orientačné číslo bydliska štatutárneho orgánu "68"
    statutory.postal_code string Poštové smerové číslo bydliska štatutárneho orgánu "114 59"
    statutory.municipality string Obec bydliska štatutárneho orgánu "Štokholm"
    statutory.country string Krajina bydliska štatutárneho orgánu "Švédske kráľovstvo"
    datahub_corporate_body.id integer Unikátny identifikátor záznamu 1532254
    datahub_corporate_body.url string Odkaz na záznam v Datahub API
    (odkazy na ostatné registre s ďalšími údajmi)    		 "https://datahub.ekosystem.slovensko.digital/api/datahub/corporate_bodies/1532254"
  4. Pridajte CSS štýly pre jQuery autocomplete. Toto sú ukážkové štýly, ktoré vidíte na tejto stránke. 
    .ui-autocomplete {
  width: inherit;
  position: absolute;
  z-index: 1000;
  padding: 0;
  list-style: none;
  background-color: #ffffff;
  border: 1px solid #ccc;
  border-radius: 4px;
  box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075);
}

.ui-autocomplete > li {
  padding: 6px 12px;
  cursor: pointer;
  cursor: hand;
  transition: background-color ease-in-out 0.15s;
}

.ui-autocomplete > li.terminated {
  text-decoration: line-through;
}

.ui-autocomplete > li.ui-state-focus {
  background-color: rgb(238, 238, 238);
}

.ui-helper-hidden-accessible {
  display: none;
}

Pokročilé nastavenia

Volitelný počet výsledkov

Na prvku form je možné uviesť voliteľný atribút data-slovensko-digital-autoform-limit, ktorý nastavuje počet výsledkov. Hodnotu atribútu je potrebné nastaviť v rozmedzí 1 až 20. Predvolená hodnota je 5 výsledkov.

Ukážka použitia
<form data-slovensko-digital-autoform-limit="10" data-slovensko-digital-autoform="SEM_API_KĽÚČ" action="...">

Filtrovanie výsledkov

Na prvku form je možné uviesť volitelný atribút data-slovensko-digital-autoform-filter s hodnotou active, ktorý nastaví filtrovania výsledkov vyhľadávania len na existujúce (nezaniknuté) subjekty.

Ukážka použitia
<form data-slovensko-digital-autoform-filter="active" data-slovensko-digital-autoform="SEM_API_KĽÚČ" action="...">

Integrácia cez API

Priame pripojenie k nášmu vyhľadávaciemu API.

Vyhľadanie právnickej osoby podľa názvu

GET https://autoform.ekosystem.slovensko.digital/api/corporate_bodies/search?q=name:slovensko.digital&private_access_token=SEM_API_KĽÚČ

Parametre
Názov Typ Popis
private_access_token string Prístupový kľúč k API. Odlišný od kľúču k JavaScript integrácii.
q string Vyhľadávaný výraz v tvare pole:výraz. Platné hodnoty pre pole sú cin: alebo name: pre IČO alebo názov.
Vyhľadáva začiatok názvu/IČO.
limit integer Počet zobrazených výsledkov. Hodnotu atribútu je potrebné nastaviť v rozmedzí 1 až 20. Predvolená hodnota je 5 výsledkov.
filter string Ak má tento atribút hodnotu active, vyhľadávanie vráti iba existujúce (nezaniknuté) subjekty.
Odpoveď

Popis atribútov

[
    {
      "id": 1358414,
      "cin": "50158635",
      "tin": 2120264674,
      "vatin": null,
      "name": "Slovensko.Digital",
      "formatted_address": "Staré Grunty 205/18, 841 04 Bratislava - mestská časť Karlova Ves",
      "street": "Staré Grunty",
      "reg_number": 205,
      "building_number": "18",
      "street_number": "205/18",
      "formatted_street": "Staré Grunty 205/18",
      "postal_code": "841 04",
      "municipality": "Bratislava - mestská časť Karlova Ves",
      "country": "Slovenská republika",
      "established_on": "2016-01-29",
      "terminated_on": null,
      "vatin_paragraph": null,
      "registration_office": "MV SR",
      "registration_number": "VVS/1-900/90-48099",
      "updated_at": "2021-05-11T02:10:10.697067Z",
      "legal_form": "Združenie (zväz, spolok, spoločnosť, klub ai.)",
      "main_economic_activity": {
        "code": "94992",
        "name": "Činnosti záujmových organizácií"
      },
      "statutory": [
        {
          "type": "Iný štatutárny orgán",
          "first_name": "Peter",
          "last_name": "Kulich",
          "prefixes": "",
          "postfixes": "",
          "formatted_name": "Peter Kulich",
          "street": "Vajnorská",
          "reg_number": 1306,
          "building_number": "7",
          "postal_code": null,
          "municipality": "Bratislava - mestská časť Nové Mesto",
          "country": "Slovenská republika"
        },
        {
          "type": "Iný štatutárny orgán",
          "first_name": "Ľubor",
          "last_name": "Illek",
          "prefixes": "",
          "postfixes": "",
          "formatted_name": "Ľubor Illek",
          "street": "Líščie údolie",
          "reg_number": 3710,
          "building_number": "33",
          "postal_code": null,
          "municipality": "Bratislava - mestská časť Karlova Ves",
          "country": "Slovenská republika"
        }
      ],
      "datahub_corporate_body": {
        "id": 1358414,
        "url": "https://datahub.ekosystem.slovensko.digital/api/datahub/corporate_bodies/1358414"
      }
    }
]

Vyhľadanie právnickej osoby podľa IČO

GET https://autoform.ekosystem.slovensko.digital/api/corporate_bodies/search?q=cin:50158635&private_access_token=SEM_API_KĽÚČ

Parametre
Názov Typ Popis
private_access_token string Prístupový kľúč k API. Odlišný od kľúču k JavaScript integrácii.
q string Vyhľadávaný výraz v tvare pole:výraz. Platné hodnoty pre pole sú cin: alebo name: pre IČO alebo názov.
Vyhľadáva začiatok názvu/IČO.
limit integer Počet zobrazených výsledkov. Hodnotu atribútu je potrebné nastaviť v rozmedzí 1 až 20. Predvolená hodnota je 5 výsledkov.
filter string Ak má tento atribút hodnotu active, vyhľadávanie vráti iba existujúce (nezaniknuté) subjekty.
Odpoveď

Popis atribútov

[
    {
      "id": 1358414,
      "cin": "50158635",
      "tin": 2120264674,
      "vatin": null,
      "name": "Slovensko.Digital",
      "formatted_address": "Staré Grunty 205/18, 841 04 Bratislava - mestská časť Karlova Ves",
      "street": "Staré Grunty",
      "reg_number": 205,
      "building_number": "18",
      "street_number": "205/18",
      "formatted_street": "Staré Grunty 205/18",
      "postal_code": "841 04",
      "municipality": "Bratislava - mestská časť Karlova Ves",
      "country": "Slovenská republika",
      "established_on": "2016-01-29",
      "terminated_on": null,
      "vatin_paragraph": null,
      "registration_office": "MV SR",
      "registration_number": "VVS/1-900/90-48099",
      "main_corporate_body": null,
      "updated_at": "2021-05-11T02:10:10.697067Z",
      "legal_form": "Združenie (zväz, spolok, spoločnosť, klub ai.)",
      "main_economic_activity": {
        "code": "94992",
        "name": "Činnosti záujmových organizácií"
      },
      "statutory_bodies": [
        {
          "type": "Iný štatutárny orgán",
          "first_name": "Peter",
          "last_name": "Kulich",
          "prefixes": "",
          "postfixes": "",
          "formatted_name": "Peter Kulich",
          "street": "Vajnorská",
          "reg_number": 1306,
          "building_number": "7",
          "postal_code": null,
          "municipality": "Bratislava - mestská časť Nové Mesto",
          "country": "Slovenská republika"
        },
        {
          "type": "Iný štatutárny orgán",
          "first_name": "Ľubor",
          "last_name": "Illek",
          "prefixes": "",
          "postfixes": "",
          "formatted_name": "Ľubor Illek",
          "street": "Líščie údolie",
          "reg_number": 3710,
          "building_number": "33",
          "postal_code": null,
          "municipality": "Bratislava - mestská časť Karlova Ves",
          "country": "Slovenská republika"
        }
      ],
      "statutory": [
        {
          "type": "Iný štatutárny orgán",
          "first_name": "Peter",
          "last_name": "Kulich",
          "prefixes": "",
          "postfixes": "",
          "formatted_name": "Peter Kulich",
          "street": "Vajnorská",
          "reg_number": 1306,
          "building_number": "7",
          "postal_code": null,
          "municipality": "Bratislava - mestská časť Nové Mesto",
          "country": "Slovenská republika"
        },
        {
          "type": "Iný štatutárny orgán",
          "first_name": "Ľubor",
          "last_name": "Illek",
          "prefixes": "",
          "postfixes": "",
          "formatted_name": "Ľubor Illek",
          "street": "Líščie údolie",
          "reg_number": 3710,
          "building_number": "33",
          "postal_code": null,
          "municipality": "Bratislava - mestská časť Karlova Ves",
          "country": "Slovenská republika"
        }
      ],
      "datahub_corporate_body": {
        "id": 1358414,
        "url": "https://datahub.ekosystem.slovensko.digital/api/datahub/corporate_bodies/1358414"
      }
    }
]