Definicje schem można pobrać poniżej:
Certyfikaty komunikacyjne pozwalają na uwierzytelnienie w systemie bez konieczności wielokrotnego wpisywania PINu podpisu kwalifikowanego.
Certyfikaty komunikacyjne wystawiane są po przedstawieniu podpisanego podpisem kwalifikowanym żądania wystawienia certyfikatu.
Certyfikat komunikacyjny ma Distinguished Name składające się z:
Data notAfter certyfikatu komunikacyjnego ustawiana jest na taką samą wartość jak data notAfter certyfikatu kwalifikowanego dla którego wystawiany jest certyfikat komunikacyjny.
Certyfikat komunikacyjny jest powiązany w bazie z certyfikatem kwalifikowanym, dla którego został wystawiony. Jeżeli certyfikat kwalifikowany zostanie zablokowany dla Instutucji Obowiązanej, to certyfikat komunikacyjny wystawiony dla tego certyfikatu kwalifikowanego nie pozwoli na dostęp do Instytucji Obowiązanej. Jeżeli certyfikat kwalifikowany zostanie w systemie oznaczony jako zastrzeżony, to certyfikat komunikacyjny nie zostanie przyjęty.
Ponadto istnieje możliwość zastrzeżenia certyfikatu komunikacyjnego, powoduje to, że certyfikat komunikacyjny nie zostanie przyjęty, ale nie wpływa na ważność powiązanego z nim certyfikatu kwalifikowanego. (Use case: skradziono komputer, na którym znajdował się klucz do certyfikatu komunikacyjnego, ale nie skradziono karty podpisu elektronicznego).
System SI*GIIF gwarantuje, że numer seryjny certyfikatu komunikacyjnego będzie unikalny (nawet w przypadku zmiany CA dla certyfikatów komunikacyjnych).
/api/rest2018/certyfikatyKomunikacyjne/CA
GET
application/x-pem-file
brak
brak
Lista certyfikatów CA dla certyfikatów komunikacyjnych. Zwracana jako konkatenacja plików PEM z certyfikatami CA.
/api/rest2018/certyfikatyKomunikacyjne/:hash
GET
application/pkix-certapplication/x-pem-filebrak
Certyfikat komunikacyjny.
To wywołanie pozwala pobrać certyfikat używany do szyfrowania plików z transakcjami, zawiadomień i załączników zawiadomień.
/api/rest2018/certyfikatSzyfrowania
GET
application/x-pem-file application/pkix-cert
brak
brak
Zwraca certyfikat odpowiednio w formacie PEM lub DER.
To wywołanie pozwala zarejestrować nową Instytucję Obowiązaną.
/api/rest2018/instytucje
POST
application/xml
text/plain
Podpisany dokument zgodny z http://crd.gov.pl/wzor/2018/10/19/5991/
Dane muszą być podpisane kwalifikowanym podpisem elektronicznym.
To wywołanie zwraca listę instytucji obowiązanych, do których można uzyskać dostęp z użyciem przedstawionego certyfikatu komunikacyjnego.
/api/rest2018/instytucje
GET
application/xml
Wzajemny TLS z wykorzystaniem certyfikatu komunikacyjnego
Dokument XML zgodny z namespace http://www.giif.mofnet.gov.pl/xsd/rest/instytucje20181218
To wywołanie zwraca informacje o jednej Instytucji Obowiązanej. Aby pobrać informacje o instutucji, użytkownik musi być uwierzytelniony certyfikatem komunikacyjnym zapewniającym dostęp do tej instytucji.
/api/rest2018/instutucje/:nip
GET
application/xml
Wzajemny TLS z wykorzystaniem certyfikatu komunikacyjnego
Dokument XML o formacie zbliżonym do opisanego w namespace http://crd.gov.pl/wzor/2018/10/19/5991/
Dane w zwracanym dokumencie XML odzwierciedlają zatwierdzone dane Instytucji w systemie SI*GIIF. W szczególności mogą one nie zawierać zmian wprowadzonych przez zakualizacje wykonane w ostatnim dniu roboczym.
Dla instytucji zarejestrowanych zgodnie z przepisami ustawy z 2001 roku, które nie dokonały aktualizacji danych, niektóre pola uważane w schemie za obowiązkowe, pozostaną nie wypełnione (np. OsobaKontaktowa).
To wywołanie pozwala zarejestrować zmianę informacji o instytucji obowiązanej.
Uwaga: Taka zmiana, nim zostanie uwzględniona w systemie oczekuje na akceptację operatora (pracownika GIIFa) w systemie SI*GIIF.
/api/rest2018/instutucje/:nip
PUT
application/xml
Podpisany dokument XML zgodny z namespace http://crd.gov.pl/wzor/2018/10/19/5991/
Dane muszą być podpisane kwalifikowanym podpisem elektronicznym.
To wywołanie zwraca listę certyfikatów kwalifikowanych zarejestrowanych dla Instytucji Obowiązanej.
/api/rest2018/instutucje/:nip/certyfikaty
GET
application/xml
Wzajemny TLS z wykorzystaniem certyfikatu komunikacyjnego
Element certyfikaty z namespace’a http://www.giif.mofnet.gov.pl/xsd/rest/certyfikaty20171017
To wywołanie zwraca listę certyfikatów komunikacyjnych powiązanych ze wskazanym certyfikatem kwalifikowanym
/api/rest2018/instutucje/:nip/certyfikaty/:cioId/komunikacyjne
GET
application/xml
Wzajemny TLS z wykorzystaniem certyfikatu komunikacyjnego
Element certyfikaty z namespace’a http://www.giif.mofnet.gov.pl/xsd/rest/certyfikaty20171017
To wywołanie pozwala zarejestrować certyfikaty kwalifikowane w Instytucji Obowiązanej oraz zarejestrować CSR.
Jeżeli wywołanie jest używane do rejestracji CSR, to lista przekazywanych certyfikatów kwalifikowanych musi być pusta lub zawierać wyłącznie certyfikat użyty do podpisania tego żądania.
/api/rest2018/instutucje/:nip/certyfikaty
POST
application/xml
Element RejestracjaCertyfikatu z namespace’a http://www.giif.mofnet.gov.pl/xsd/rest/certyfikaty20171017
Dane muszą być podpisane kwalifikowanym podpisem elektronicznym.
To wywołanie pozwala zablokować dostęp certyfikatu kwalifikowanego do Instytucji Obowiązanej oraz zablokować certyfikaty komunikacyjne.
/api/rest2018/instutucje/:nip/certyfikaty/zablokuj
POST
application/xml
Element BlokadaCertyfikatu z namespace’a http://www.giif.mofnet.gov.pl/xsd/rest/certyfikaty20171017
Element certyfikat zawiera certyfikat kwalifikowany do zablokowania. Jeśli blokowany jest certyfikat komunikacyjny to można wskazać, elementem nip, listę instytucji w których certyfikat zostanie zablokowany, domyślnie certyfikat blokowany jest w instytucji wskazanej w NIPie podanym w URL.
Element certyfikatKomunikacyjny zawiera certyfikat komunikacyjny do zablokowania.
Nie można jednocześnie blokować certyfikatów kwalifikowanych i certyfikatów komunikacyjnych.
Dane muszą być podpisane kwalifikowanym podpisem elektronicznym.
To wywołanie zwraca listę plików przesłanych przez Instytucję Obowiązaną. Lista plików jest sortowana po dacie otrzymania pliku, malejąco.
/api/rest2018/instutucje/:nip/pliki?wyslanePo&wyslanePrzed&hashZaszyfrowany&hashJawny&status&od&ilosc
GET
application/xml
yyyy-MM-dd (xsd:date), yyyy-MM-ddThh:mm:ss i wariant ze strefą czasową: yyyy-MM-ddThh:mm:ss+hh:mm (xsd:dateTime). Jeżeli nie wskazano strefy czasowej, to przyjmowana jest Europe/Warsaw. Opcjonalne
Wzajemny TLS z wykorzystaniem certyfikatu komunikacyjnego
200 :Element pliki z namespace’a http://www.giif.mofnet.gov.pl/xsd/rest/pliki20171017
To wywołanie pozwala przesłać plik z transakcjami.
/api/rest2018/instytucje/:nip/pliki
POST
Zaszyfrowany plik z transakcjami.
Nazwę pliku można przekazać ustawiając nagłówek Content-Disposition na attachment z nazwą pliku w polu filename lub filename*
Wzajemny TLS z wykorzystaniem certyfikatu komunikacyjnego
200 :Element plik z namespace’a http://www.giif.mofnet.gov.pl/xsd/rest/pliki20171017
409 :Plik powtórnie przesłany.
413 :Plik większy niż dopuszczalny rozmiar.
To wywołanie zwraca Urzędowe Poświadczenie Odbioru dla wskazanego pliku
/api/rest2018/instutucje/:nip/pliki/:plzId/upo
GET
application/xml
Wzajemny TLS z wykorzystaniem certyfikatu komunikacyjnego
To wywołanie zwraca listę komunikatów do Instytucje Obowiązanej.
/api/rest2018/instutucje/:nip/komunikaty
GET
application/xml
Wzajemny TLS z wykorzystaniem certyfikatu komunikacyjnego
Element komunikaty z namespace’a http://www.giif.mofnet.gov.pl/xsd/rest/komunikaty20171017
To wywołanie zwraca listę wyróżników komunikatów do Instytucje Obowiązanej.
/api/rest2018/instutucje/:nip/komunikaty/wyrozniki?q
GET
application/xml
Wzajemny TLS z wykorzystaniem certyfikatu komunikacyjnego
Element wyrozniki z namespace http://www.giif.mofnet.gov.pl/xsd/rest/komunikaty20171017
To wywołanie zwraca komunikat do Instytucji Obowiązanej.
/api/rest2018/instutucje/:nip/komunikaty/:rodzaj/:kmkId
GET
application/xml
Wzajemny TLS z wykorzystaniem certyfikatu komunikacyjnego
Element komunikat z namespace’a http://www.giif.mofnet.gov.pl/xsd/rest/komunikaty20171017
To wywołanie zwraca komunikat do Instytucji Obowiązanej.
/api/rest2018/instutucje/:nip/komunikaty/:rodzaj/:kmkId/zalaczniki/:id
GET
application/xml
Wzajemny TLS z wykorzystaniem certyfikatu komunikacyjnego
Plik załącznika.
To wywołanie zwraca listę zawiadomień otrzymanych od Insytucji Obowiązanej Lista zawiadomień jest sortowana po dacie otrzymania pliku, malejąco.
/api/rest2018/instutucje/:nip/zawiadomienia?wyslanePo&wyslanePrzed&hashZaszyfrowany&hashJawny&status&typZawiadomienia&od&ilosc
GET
application/xml
yyyy-MM-dd (xsd:date), yyyy-MM-ddThh:mm:ss i wariant ze strefą czasową: yyyy-MM-ddThh:mm:ss+hh:mm (xsd:dateTime). Jeżeli nie wskazano strefy czasowej, to przyjmowana jest Europe/Warsaw. Opcjonalne
Wzajemny TLS z wykorzystaniem certyfikatu komunikacyjnego
zawiadomienia z namespace’a http://www.giif.mofnet.gov.pl/xsd/rest/pliki20171017
To wywołanie zwraca informacje o jednym zawiadomieniu otrzymanym od Insytucji Obowiązanej
/api/rest2018/instutucje/:nip/zawiadomienia/:zwdId
GET
application/xml
Wzajemny TLS z wykorzystaniem certyfikatu komunikacyjnego
zawiadomienie z namespace’a http://www.giif.mofnet.gov.pl/xsd/rest/pliki20171017
To wywołanie zwraca Urzędowe Poświadczenie Odbioru dla wskazanego Zawiadomienia
/api/rest2018/instutucje/:nip/zawiadomienia/:zwdId/upo
GET
application/xml
Wzajemny TLS z wykorzystaniem certyfikatu komunikacyjnego
To wywołanie pozwala przesłać eZawiadomienie lub eOdpowiedź.
/api/rest2018/instytucje/:nip/zawiadomienia
POST
Zaszyfrowany, podpisany plik eZawiadomieniem. Zgodny z elementem rejestracjaZawiadomienia ze schemy http://www.giif.mofnet.gov.pl/xsd/zawiadomienia20171017
Nazwę pliku można przekazać ustawiając nagłówek Content-Disposition na attachment z nazwą pliku w polu filename lub filename*
Wzajemny TLS z wykorzystaniem certyfikatu komunikacyjnego
zawiadomienie z namespace’a http://www.giif.mofnet.gov.pl/xsd/rest/pliki20171017
To wywołanie pozwala przesłać załącznik do eZawiadomienia lub eOdpowiedzi. Po przesłaniu zawiadomienia, zwrotny XML zawiera id wskazujące numer zawiadomienia w systemie (zwiId)
/api/rest2018/instytucje/:nip/zawiadomienia/:zwiId/zalaczniki
POST
Zaszyfrowany plik z załącznikiem.
Nazwę pliku można przekazać ustawiając nagłówek Content-Disposition na attachment z nazwą pliku w polu filename lub filename*
Wzajemny TLS z wykorzystaniem certyfikatu komunikacyjnego
zalacznikZawiadomienia z namespace’a http://www.giif.mofnet.gov.pl/xsd/rest/pliki20171017