Czym jest Portal Developera Cyfrowej Piaskownicy Administracji?

Jest to centralne miejsce, w którym zainteresowany deweloper posiada dostęp do oferty usług API administracji publicznej.

Co to jest usługa API?

W ramach Cyfrowej Piaskownicy Administracji udostępniamy usługi API, które można opisać w następujący sposób:

• Udostępniają część lub całą funkcjonalności danej aplikacji lub systemu,
• Umożliwiają dostęp jedynie do danych i wtedy udostępniają zasoby,
• Są przeznaczone do maszynowego przetwarzania,
• Mają rekomendowany format opisu danych w postaci JSON, XML, a transport jest realizowany, poprzez protokół HTTP (WebAPI),
• Kontrakty usług API są wyrażone z wykorzystaniem języka opisu OpenAPI lub WSDL.

Jakie usługi udostępniamy?

W ramach Portalu Dewelopera Cyfrowej Piaskownicy Administracji udostępniamy kolekcję usług API administracji publicznej. Są to prototypy usług API, które prezentują przykładowy zakres danych lub funkcjonalości na potrzeby weryfikacji ich działania.

Czy skorzystanie z usług API wymaga logowania?

Przeglądanie usług API nie wymaga logowania, natomiast w celu skorzystania z usług API należy dokonać zgłoszenia rejestracji na Portalu Dewelopera.

Jak zarejestrować konto na Portalu Dewelopera?

Aby zarejestrować konto na Portalu Dewelopera dokonaj zgłoszenia rejestracji. Po weryfikacji przesłanych danych zostaniesz poinformowany o możliwości logowania na adres email, który podałeś w trakcie zgłoszenia.

Jak skorzystać z usług API?

W celu skorzystania z usługi API należy dokonać następujących czynności:

• Dokonaj rejestracji w Portalu Dewelopera lub wykorzystaj dane logowania, które posiadasz,
• Przeglądaj katalog usług API oraz wybierz interesującą Cię usługę API,
• Utwórz aplikację. Aplikacje są to logiczne kolekcje usług API. W ramach aplikacji możesz dokonać subskrypcji na wiele usług API i wywoływać je w ramach wygenerowanego tokenu dostępowego,
• Wygeneruj klucze dostępowe w ramach utworzonej aplikacji oraz token dostępowy,
• Wyszukaj ponownie interesującą cię usługę API, wybierz utworzoną wcześniej lub istniejącą aplikację oraz dokonaj subskrypcji na wybraną usługę API,
• Użyj konsoli API w celu obejrzenia zakresu informacyjnego oraz jaki oferuje dana usługa API. Zauważ iż w ramach czasu ważności wygenerowanego wcześniej tokenu dostępowego możesz wywoływać usługę w celach testowych bezpośrednio w konsoli API,
• W ramach danej usługi API możesz przeglądać jej dokumentację produkcyjną.

Jak uzyskać dodatkową pomoc?

Jeśli nie znalazłeś odpowiedzi na interesujące Cię pytania lub chcesz się z nami skontaktować, napisz na na adres biuro.cpa@mc.gov.pl