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í.

• 3.1. Seznámení s API
  • 3.1.1. Identifikátory entity
  • 3.1.2. Struktura entity
• 3.2. Vyhledávání
  • 3.2.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.3. Poskytování entit
  • 3.3.1. Exportní API
  • 3.3.2. Změny entit
• 3.4. Změny a tvorba entit
  • 3.4.1. Princip dávkového API
  • 3.4.2. Vložení entity
    • Příklad založení entity
  • 3.4.3. Vložení části popisu
    • Příklad vložení části
  • 3.4.4. Přidání prvků popisu
    • Příklad vložení prvků popisu
  • 3.4.5. Aktualizace hodnot prvků popisu
    • Příklad aktualizace prvků popisu
  • 3.4.6. Vymazání části záznamu entity
    • Příklad vymazání části
  • 3.4.7. Změna stavu záznamu entity
    • Příklad změny stavu
  • 3.4.8. Změna preferovaného jména
    • Příklad změny preferovaného jména
  • 3.4.9. Změna třídy/podtřídy
    • Příklad změny podtřídy entity
• 3.5. Schéma dat
  • 3.5.1. Formát souboru
  • 3.5.2. Referenční dokumentace schématu
• 3.6. REST API
  • 3.6.1. Definice REST rozhraní
  • 3.6.2. Funkce REST rozhraní
• 3.7. Zabezpečení
  • 3.7.1. Autentizace na Portálu NA ČR
  • 3.7.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