3. Programátorské rozhraní (API)

Programátorské rozhraní je založeno na REST službách s možností přenosu dat v XML formátu. Služby jsou popsány v samostatných kapitolách a formou OpenAPI rozhraní.

API je dostupné ve dvou verzích, aktuální verze je 2. Původní API ve verzi 1 bude postupně opuštěno a je považováno za zastaralé.

• 3.1. Seznámení s API
  • 3.1.1. Identifikátory entity
  • 3.1.2. Struktura entity
• 3.2. Novinky a změny API v2
  • 3.2.1. REST služby
    • Operace GET /entities/{id}
    • Operace POST /export/snapshots
    • Operace POST /export/revisions
    • Vyhledávání POST /search
    • Získání změn v entitách GET /updates?fromTransId={fromTransId}&toTransId={toTransId}
    • Zaslání změnové dávky POST /batches
    • Ověřování změnové dávky
  • 3.2.2. Schéma XML
• 3.3. Vyhledávání
  • 3.3.1. Příklady vyhledávaných podmínek
    • Vyhledání přes všechna označení
    • Vyhledání preferovaných označení pro vybranou podtřídu
    • Vyhledání s omezením na rok narození
    • Vyhledání s omezením na rozmezí data vzniku a stavu
• 3.4. Poskytování entit
  • 3.4.1. Exportní API
  • 3.4.2. Změny entit
• 3.5. Změny a tvorba entit
  • 3.5.1. Princip dávkového API
    • Uložení s varováním
    • Uživatelé
  • 3.5.2. Vložení entity
    • Příklad založení entity
  • 3.5.3. Vložení části popisu
    • Příklad vložení části
  • 3.5.4. Přidání prvků popisu
    • Příklad vložení prvků popisu
  • 3.5.5. Aktualizace hodnot prvků popisu
    • Příklad aktualizace prvků popisu
  • 3.5.6. Vymazání části záznamu entity
    • Příklad vymazání části
  • 3.5.7. Změna stavu záznamu entity
    • Příklad změny stavu
  • 3.5.8. Změna preferovaného jména
    • Příklad změny preferovaného jména
  • 3.5.9. Změna třídy/podtřídy
    • Příklad změny podtřídy entity
• 3.6. Zjištění (chyby a upozornění)
  • 3.6.1. Zjištění v rámci změn
  • 3.6.2. Zjištění z externích zdrojů
• 3.7. Schéma dat v2
  • 3.7.1. Formát souboru
  • 3.7.2. Referenční dokumentace schématu
• 3.8. REST API v2
  • 3.8.1. Definice REST rozhraní
  • 3.8.2. Funkce REST rozhraní
• 3.9. Zabezpečení
  • 3.9.1. Autentizace na Portálu NA ČR
  • 3.9.2. Autentizace pomocí API Key
    • Hlavičky požadavku
      • Hlavička X-NDA-Date
      • Hlavička Authorization
    • Způsob výpočtu podpisu požadavku
      • Příklad
      • Příklad 2
• 3.10. API verze 1
  • 3.10.1. Seznámení s API v1
    • Identifikátory entity
    • Struktura entity
  • 3.10.2. Vyhledávání
    • Příklady vyhledávaných podmínek
      • Vyhledání přes všechna označení
      • Vyhledání preferovaných označení pro vybranou podtřídu
      • Vyhledání s omezením na rok narození
      • Vyhledání s omezením na rozmezí data vzniku a stavu
  • 3.10.3. Poskytování entit
    • Exportní API
    • Změny entit
  • 3.10.4. Změny a tvorba entit
    • Princip dávkového API
    • Vložení entity
      • Příklad založení entity
    • Vložení části popisu
      • Příklad vložení části
    • Přidání prvků popisu
      • Příklad vložení prvků popisu
    • Aktualizace hodnot prvků popisu
      • Příklad aktualizace prvků popisu
    • Vymazání části záznamu entity
      • Příklad vymazání části
    • Změna stavu záznamu entity
      • Příklad změny stavu
    • Změna preferovaného jména
      • Příklad změny preferovaného jména
    • Změna třídy/podtřídy
      • Příklad změny podtřídy entity
  • 3.10.5. Schéma dat API v1
    • Formát souboru
  • 3.10.6. REST API v1
    • Definice REST rozhraní
    • Funkce REST rozhraní