Standard API
Standard określa minimalne, rekomendowane zalecenia, dotyczące interfejsu programistycznego aplikacji dostępu do baz danych, które przechowują dane publiczne. Został stworzony po to, aby administracja publiczna udostępniała swoje dane przez API według jednolitego standardu. Udostępnienie danych zgodnie ze standardem ułatwi wykorzystanie danych publicznych i łączenie ich z różnych źródeł, a w konsekwencji tworzenie innowacyjnych dóbr, usług i produktów przez przedsiębiorców, organizacje pozarządowe, programistów. Standard obejmuje m.in.: architekturę usług sieciowych REST, opis składni oraz elementów URI, czy obsługę zdarzeń http.
W 2020 r. doprecyzowaliśmy standard komunikatów (zapytania i odpowiedzi między użytkownikiem a systemem) wskazując na JSON API. Wprowadziliśmy dodatkowe rekomendacje dotyczące reguł wprowadzania limitów danych. Do minimalnego zestawu metadanych przy budowie API dodaliśmy metadaną dotyczącą sum kontrolnych dla określania kompletności zbioru oraz rekomendację dotyczącą przeprowadzania analizy kosztów i korzyści w przypadku budowy API do zasobów.
Materiały
Standard API 2020standard-api.pdf 1.42MB Standard API 2018
standard-api_03-12-2018.pdf 1.16MB API Standard 2018
api-standard_2018.odt 0.06MB