SEAP Specyfikacja XML v. 20.0

Transkrypt

Załącznik nr 2 - Interfejs WebService dla podmiotów zewnętrznych
Wersja: 20.0
ECIP_SEAP_PIS_Załącznik_2_SEAP_Specyfikacja_XML_dla_Systemow_Zewnetrznych
Data: 2016-01-18
MINISTERSTWO FINANSÓW
PLAN INTEGRACJI SYSTEMU
ZAŁĄCZNIK NR 2 – SEAP SPECYFIKACJA XML
INTERFEJS WEBSERVICE DLA PODMIOTÓW ZEWNĘTRZNYCH PL
PROJEKT ECIP/SEAP
WERSJA <20.0>
1 z 34
Izba Celna w Rzepinie, ul. Dworcowa 5, 69-110 Rzepin | tel.: (95) 750 93 01 | fax: (95) 750-93-96
| e-mail: [email protected]
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
Spis treści
1.
Interfejs WebService dla podmiotów zewnętrznych ...................................... 4
1.1. Cel dokumentu ......................................................................................................... 4
1.2. Zastosowanie ........................................................................................................... 4
1.3. Zawartość dokumentu .............................................................................................. 4
1.4. Dokumenty źródłowe i pomocniczne .......................................................................... 4
1.5. Skróty i terminy ........................................................................................................ 5
1.6. Ograniczenia specyfikacji.......................................................................................... 6
1.7. Układ specyfikacji .................................................................................................... 6
2.
Operacje biznesowe: kierunek Podmiot Zewnętrzny –> PUESC ...................... 7
2.1. Przesłanie dokumentu do PUESC .............................................................................. 7
2.2. Pobranie niepobranego wcześniej dokumentu od PUESC ............................................ 8
2.3. Pobranie niepobranego wcześniej dokumentu od PUESC wg IdSisc ............................. 8
2.4. Pobranie zbioru dokumentów od PUESC .................................................................... 9
3.
Struktura danych: kierunek Podmiot Zewnętrzny –> PUESC ........................ 11
3.1. Przesłanie dokumentu do PUESC ............................................................................ 11
3.2. Pobranie niepobranego wcześniej dokumentu od PUESC .......................................... 12
3.3. Pobranie niepobranego wcześniej dokumentu od PUESC wg IdSisc ........................... 13
3.4. Pobranie zbioru dokumentów od PUESC .................................................................. 14
3.5. Informacje o błędach .............................................................................................. 15
4.
Operacje biznesowe: kierunek PUESC –> Podmiot Zewnętrzny.................... 17
4.1. Wysłanie dokumentu przez PUESC .......................................................................... 18
5.
Struktura danych: kierunek PUESC –> Podmiot Zewnętrzny ........................ 19
6.
Diagram struktury WS_CHANNEL.xsd ...................................................... 23
7.
Przepływ dokumentów - Komunikaty........................................................ 26
2 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
8.
Przepływ dokumentów - Komunikaty – Dodatkowe elementy XML ................ 29
9.
Często zadawane pytania, FAQ ............................................................... 33
9.1. Jaki standard WS-Security należy użyć? .................................................................. 33
9.2. Czy można wysyłać wiadomości do PUESC bez użycia SSL? ..................................... 33
9.3. Co to jest idSISC w szczególności pierwsze, drugie i trzecie? .................................... 33
9.4. Co można zrobić z otrzymanym identyfikatorem sysRef? .......................................... 33
9.5. Co jeśli nie jest znana nazwa użytkownika i hasło do podłączenia się po WS-Security? 33
9.6. Co jeśli używamy WS_PUSH.wsdl i zmieniliśmy certyfikat SSL? ................................ 34
3 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
1. Interfejs WebService dla podmiotów zewnętrznych
1.1. Cel dokumentu
Celem niniejszej specyfikacji jest opis zdefiniowanej struktury i zawartości
informacyjnej dokumentów XML (zwanych tutaj także komunikatami), wysyłanych
i odbieranych przez System SEAP w komunikacji z podmiotami zewnętrznymi.
1.2. Zastosowanie
Dokument będzie wykorzystywany jako źródłowy przy projektowaniu,
implementacji oraz tworzeniu dokumentacji testowej i użytkowej Systemu.
Adresatem dokumentu jest zespół analityczno-projektowy po stronie Administracji
Celnej oraz zespoły: projektantów, programistów, testerów i dokumentalistów po
stronie Wykonawcy oraz firm zajmujących się tworzeniem oprogramowania do
obsługi celnej podmiotów gospodarczych.
1.3. Zawartość dokumentu
Dokument zawiera opis specyfikacji XSD i komunikatów WSDL przesyłanych do
Systemu SEAP/PUESC jak i komunikatów wysyłanych z Systemu SEAP/PUESC
do systemów podmiotów zewnętrznych.
1.4. Dokumenty źródłowe i pomocniczne





Plan Integracji Systemu
Specyfikacje XSD - http://www.w3.org/XML/Schema
Specyfikacje WSDL - http://www.w3.org/TR/2002/WD-wsdl12-20020709/
Specyfikacje SOAP - http://www.w3.org/TR/soap/
Specyfikacja WS-SecurityPolicy http://specs.xmlsoap.org/ws/2005/07/securitypolicy/ws-securitypolicy.pdf
4 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
1.5. Skróty i terminy
Termin
Definicja
XML
ang. Extensible Markup Language - uniwersalny język znaczników przeznaczony do
reprezentowania różnych danych w strukturalizowany sposób.
XSD
ang. XML Schema - opracowany przez W3C standard służący do definiowania struktury
dokumentu XML.
WSDL
ang. Web Services Description Language - oparty na XML język do definiowania usług
sieciowych.
SOAP
ang. Simple Object Access Protocol - protokół wywoływania zdalnego dostępu do
obiektów, wykorzystujący XML do kodowania wywołań.
SEAP
ang. Single Entry Access Point – pol. PUESC
PUESC
Portal Usług Elektronicznych Służby Celnej – ang. SEAP
Podmiot Zewnętrzny
Firma, agencja lub osoba, która chce korzystać z niewizualnych usług PUESC
opisanych w tym dokumencie.
CRKiD
Centralne Repozytorium Komunikatów i Dokumentów – komponent systemu SEAP.
5 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
1.6. Ograniczenia specyfikacji
Specyfikacja definiuje strukturę XML jako nośnik (warstwa logiczna) do przesyłania
innych komunikatów celnych. W związku z tym nie definiuje ona struktur komunikatów
celnych takich, jak IE515, AKC-N, itd. Definiuje ona sposób transmisji tych komunikatów
zamykając (enkapsulując) je w specyficzną dla e-Cła warstwę logiczną.
1.7. Układ specyfikacji
Specyfikacja składa się z jednego modelu danych i dwóch modeli komunikacyjnych:
1. Plik WS_CHANNEL.xsd – model przesyłanych danych
2. Plik WS_PULL.wsdl – model komunikacyjny od Podmiotu Zewnętrznego do SEAP
3. Plik WS_PUSH.wsdl – model komunikacyjny od SEAP do Podmiotu Zewnętrznego
6 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
2. Operacje biznesowe: kierunek Podmiot Zewnętrzny –>
PUESC
Podmiot Zewnętrzny może realizować operacje biznesowe korzystając po swojej stronie z
interfejsu WS_PULL.wsdl, a następnie komunikując się przy jego użyciu:


z systemem PUESC przez adres URL
https://ws.puesc.gov.pl/seap_wsChannel/DocumentHandlingPort?wsdl,
a na środowisku testowym odpowiednio przez adres URL
https://wstest.puesc.gov.pl/seap_wsChannel/DocumentHandlingPort?wsdl
UWAGA.
Podmiot Zewnętrzny, aby móc wykorzystywać usługi elektroniczne przez WebService musi
posiadać konto na Portalu PUESC. Login PUESC (czyli adres email użytkownika) jest
jednocześnie loginem do usług elektronicznych WebService, określonych w tym rozdziale.
Login i skrót SHA1 (base64) z hasła muszą zatem zostać przekazane do usługi WebService
zgodnie ze specyfikacją WS-Security, profil UsernameToken, tryb PasswordDigest. Zgodnie
z zawartą w pliku WS_PULL.wsdl polityką <wsp:Policy wsu:Id="ecipseap_policy">.
Podmiot Zewnętrzny ma do dyspozycji jedną operację biznesowe związaną z wysłaniem
dokumentów elektronicznych XML do PUESC oraz trzy operacje związane z odebraniem z
PUESC dokumentów elektronicznych XML.
2.1. Przesłanie dokumentu do PUESC
Operacja ta jest realizowana metodą AcceptDocumentRequest interfejsu WS_PULL.wsdl.
Nośnikiem informacji (warstwą logiczną) jest obiekt „document” opisany dalej w specyfikacji
i dostępny w pliku WS_CHANNEL.xsd.
Po wywołaniu metody AcceptDocumentRequest następuje odesłanie synchroniczne
odpowiedzi w postaci AcceptDocumentResponse – nośnikiem odpowiedzi jest obiekt
„result” opisany dalej w specyfikacji i dostępny w pliku WS_CHANNEL.xsd.
7 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
2.2. Pobranie niepobranego wcześniej dokumentu od PUESC
Operacja ta jest realizowana metodą GetNextDocumentRequest interfejsu WS_PULL.wsdl.
Operacja ta jest bezargumentowa, ponieważ odpytuje system o zwrócenie kolejnego
niepobranego dokumentu – wyszukiwany jest najstarszy, niepobrany dokument wraz z
załącznikami (jeśli je posiada).
Operacja posiada synchroniczną odpowiedź GetNextDocumentResponse – nośnikiem
odpowiedzi jest obiekt „document” opisany dalej w specyfikacji i dostępny w pliku
WS_CHANNEL.xsd.
2.3. Pobranie niepobranego wcześniej dokumentu od PUESC wg
IdSisc
Operacja ta jest realizowana metodą GetNextDocumentSisc interfejsu WS_PULL.wsdl.
Operacja ta przyjmuje jeden argument GetNextDocumentSiscRequest, opisany dalej
w specyfikacji.
Operacja posiada synchroniczną odpowiedź GetNextDocumentResponse – nośnikiem
WS_CHANNEL.xsd.
Podobnie do metody GetNextDocument, metoda GetNextDocumentSisc pobiera
najstarszy niepobrany dokument wraz z załącznikami (jeśli je posiada) i rozszerza zakres
GetNextDocument o filtrowanie po zadanych identyfikatorach idSisc.
Użytkownik, który autentykuje się wysyłając zapytanie GetNextDocumentSisc za pomocą
WS-Security musi posiadać uprawnienia do zadanych identyfikatorów. W przeciwnym
przypadku usługa odpowie błędem.
8 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
2.4. Pobranie zbioru dokumentów od PUESC
Operacja ta jest realizowana metodą GetDocuments interfejsu WS_PULL.wsdl. Operacja ta
przyjmuje jeden argument GetDocumentsRequest, opisany dalej w specyfikacji.
Operacja posiada synchroniczną odpowiedź GetDocumentsResponse – nośnikiem
WS_CHANNEL.xsd.
Metoda ta pozwala na pobranie zbioru dokumentów na podstawie zadanych kryteriów takich
jak identyfikator idSisc, unikalny identyfikator dokumentu (sysRef), zakres dat nadania.
Metoda pozwala na zdefiniowanie czy mają być pobierane dokumenty tylko niepobrane, tylko
pobrane, czy też wszystkie. Każdy z dokumentów zwracany jest wraz z załącznikami (jeśli je
posiada).
9 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
Poniższy rysunek przedstawia przepływ informacji w tych operacjach biznesowych.
System Podatnika to system podmiotu zewnętrznego.
10 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
3. Struktura danych: kierunek Podmiot Zewnętrzny –>
PUESC
Podmiot Zewnętrzny komunikuje się z systemem SEAP za pomocą struktur danych
określonych w pliku WS_CHANNEL.xsd, pola struktur są zależne od kierunku przepływu
informacji.
3.1. Przesłanie dokumentu do PUESC
System Podmiotu Zewnętrznego musi dostarczyć obiekt
AcceptDocumentRequest zgodny z następującą strukturą:
Element / Atrybut
document
- content
- content/@filename
- content/@mime
- attachments
- targetSystems
Powtarzalność
1
1
1
1
0..1
0..1
„document”
do
metody
Typ
documentType
contentType
string
mimeType
attachmentsType
targetSystemsType
Opis poszczególnych elementów i atrybutów:





/document – element główny, który zawiera wszystkie pozostałe elementy
/document/content – element zawierający właściwy plik, który ma zostać dostarczony
do systemu celnego
/document/content/<value> – zawartość binarna typu Base64
/document/content/@filename – nazwa pliku, typ znakowy o liczbie znaków
maksymalnie 128
/document/content/@mime – określenie typu MIME dla zawartości (pliku),
dopuszczalne wartości to „application/xml” „application/pdf” „other”
11 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18


/document/attachments/ – lista załączników poza dokumentem głównym, które należy
przesłać razem, np.: System Podmiotu Zewnętrznego chce dostarczyć podpisany plik
XML, ale dodatkowo w parze ma być plik PDF jako załącznik.
o /document/attachments/attachment/@filename – nazwa pliku (maksymalnie
128 znaków).
o /document/attachments/attachment/@mime – typ pliku (np. application/xml)
o /document/attachments/attachment/<value> – zakodowany przy użyciu
Base64 ciąg znaków będący binarną treścią załącznika
/document/targetSystems/…/system – lista wskazań Systemów Służby Celnej, do
których należy wysłać dokument
W synchronicznej odpowiedzi AcceptDocumentResponse System PUESC zwróci obiekt
„result” zgodny z następującą strukturą:
Element / Atrybut
result
- sysRef
Powtarzalność
1
1
Typ
resultType
string


/result – element główny, który zawiera wszystkie pozostałe elementy
/result/sysRef – unikalny identyfikator dokumentu zwracany przez PUESC do
Systemu Podmiotu Zewnętrznego o liczbie znaków maksymalnie 256
3.2. Pobranie niepobranego wcześniej dokumentu od PUESC
System Podmiotu Zewnętrznego może odpytać PUESC o następny niepobrany dokument
używając do tego metody GetNextDocumentRequest. Metoda ta nie ma argumentów
i zwróci kolejny (najstarszy) niepobrany dokument dla użytkownika, z którego została
przeprowadzona autoryzacja WS-Security.
12 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
Odpowiedzią synchroniczną na powyższe zapytanie jest GetNextDocumentResponse,
który zwróci obiekt typu „document” w ten sam sposób, jak przy doręczaniu przez PUESC.
Pola struktury „document” zostaną wypełnione zgodne z opisem w rozdziale nr 5.
Jeżeli wszystkie dokumenty zostały odebrane to odpowiedz GetNextDocumentResponse
nie będzie zawierać obiektu „document”.
3.3. Pobranie niepobranego wcześniej dokumentu od PUESC wg
IdSisc
System Podmiotu Zewnętrznego może odpytać PUESC o następny (najstarszy) niepobrany
dokument wg idSisc używając do tego metody GetNextDocumentSisc. Metoda ta przyjmuje
jeden parametr GetNextDocumentSiscRequest opisany poniżej:
Element
idSiscROF
Opis
identyfikator użytkownika (osoby fizycznej) w
ramach Systemu Informacyjnego Służby Celnej
idSiscROP identyfikator użytkownika (podmiotu
pośredniczącego) w ramach Systemu
Informacyjnego Służby Celnej
idSiscP
identyfikator użytkownika (podmiotu) w ramach
Systemu Informacyjnego Służby Celnej
Powtarzalność
0..1*
Typ
string
0..1*
string
0..1*
string
* w przypadku nie podania żadnego z pól idSiscROF/idSiscROP/idSiscP zostanie
automatycznie przypisana wartość idSiscROF na podstawie użytkownika
autentykującego się za pomocą WS-Security
Odpowiedzią synchroniczną na powyższe zapytanie jest GetNextDocumentResponse identycznie jak w przypadku metody GetNextDocument.
Użytkownik, który autentykuje się wysyłając zapytanie GetNextDocumentSisc za pomocą
WS-Security musi posiadać uprawnienia do podanych identyfikatorów. W przeciwnym
przypadku usługa odpowie błędem.
13 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
Pobranie zbioru dokumentów od PUESC
System Podmiotu Zewnętrznego może odpytać PUESC o zbiór dokumentów używając do
tego metody GetDocuments. Metoda ta przyjmuje jeden parametr GetDocumentsRequest
opisany poniżej:
Opis
Powtarzalność
Typ
identyfikator użytkownika (osoby fizycznej) w
0..1*
string
ramach Systemu Informacyjnego Służby
Celnej
idSiscROP
identyfikator użytkownika (podmiotu
0..1*
string
pośredniczącego) w ramach Systemu
Informacyjnego Służby Celnej
idSiscP
identyfikator użytkownika (podmiotu) w ramach
0..1*
string
Systemu Informacyjnego Służby Celnej
sysRef
unikalny identyfikator dokumentu
0..1
string
idWysylki
identyfikator wysyłki
0..1
string
idDocSysZew numer własny
0..1
string
idSprawy
identyfikator sprawy
0..1
string
dataOd
początek zakresu dat dla daty nadania
0..1**
date
dokumentu
dataDo
koniec zakresu dat dla daty nadania
0..1**
date
dokumentu
pobrany
0 - dokumenty pobrane i niepobrane, 1 - tylko
0..1
integer
dokumenty pobrane, 2 (domyślnie) - tylko
dokumenty niepobrane
* w przypadku nie podania żadnego z pól idSiscROF/idSiscROP/idSiscP zostanie
automatycznie przypisana wartość idSiscROF na podstawie użytkownika
autentykującego się za pomocą WS-Security
** zakres dat nie może być szerszy niż 10 dni, a jego zdefiniowanie w zapytaniu jest
obligatoryjne w przypadku gdy nie określono parametrów idWysylki, sysRef lub
idDocSysZew
Element
idSiscROF
Użytkownik, który autentykuje się wysyłając zapytanie GetDocuments za pomocą WSSecurity musi posiadać uprawnienia do podanych identyfikatorów. W przeciwnym przypadku
usługa odpowie błędem.
14 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
Odpowiedzią synchroniczną na powyższe zapytanie jest kolekcja elementów typu
„document”.
3.4. Informacje o błędach
Ponadto istnieją struktury danych dla błędów biznesowych i technicznych, a mianowicie:
1. businessErrorType
2. techErrorType
Obie struktury składają się z następujących elementów:
/error – element główny
/error/errorCode – identyfikator błędu
/error/errorDesc – opis błędu
Dla kierunku przepływu informacji od Systemu Podmiotu Zewnętrznego do systemu PUESC,
system PUESC może odpowiedzieć następującymi błędami:
1. błędy biznesowe typu businessErrorType (odpowiednio kod i opis błedu):
1.1. B001 – xml namespace not recognized - w systemie brak skonfigurowanej schemy
XSD dla zawartości dokumentu w strukturze /document/content
1.2. B002 – xml namespace not configured - w systemie istnieje schemat, ale brak dla
niego konfiguracji
1.3. B003 – xml namespace not in date range - znaleziono schemat XSD, ale nie jest on
obowiązujący
1.4. B004 – namespace not in match with Customs System selection - odnaleziono
schemat XSD, ale system wskazany w strukturze /document/targetSystem nie
odpowiada temu schematowi
1.5. B005 – namespace not allowed in webservice - schemat XSD nie pozwala na
obsługę w kanale webservice
1.6. B006 - niepoprawne parametry wejściowe, np:

B006 No permission to idSiscROF/idSiscROP/idSiscP - gdy dla metody
GetNextDocumentSisc użytkownik nie posiada uprawnień do danego
identyfikatora

B006 At least one of idSisc needs to be provided - gdy dla metody
GetNextDocumentSisc w zapytaniu nie zostanie zadany żadne z identyfikatorów
idSiscROF/idSiscROP/idSiscP

B006 DataOd and DataDo must be defined and must be limited up to 10 days
period - w przypadku gdy dla metody GetDocuments nie zostanie zadany
15 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
identyfikator idSiscROF/idSiscROP/idSiscP oraz nie został zdefiniowany
przedział czasowy dla wyszukiwania dokumentów

B006 DataOd cannot be later than DataDo - w przypadku gdy dla metody
GetDocuments data początkowa jest późniejsza niż data końcowa

B006 Period between DataOd and DataDo must be limited up to 10 days - w
przypadku gdy został zdefiniowany zakres dat dla wyszukiwania, ale przekracza
on dopuszczalny zakres tj. 10 dni.
2. błędy techniczne typu techErrorType (odpowiednio kod i opis):
2.1. E001 – malformed base64 content - zawartość nie jest zakodowana w formacie
Base64
2.2. E002 – mime does not match with content - deklarowany typ MIME nie zgadza się z
zawartością
2.3. E003 – other error - błąd innego rodzaju np:
- E003 - PDR not available. Please try again later - w przypadku gdy nie powiedzie
się próba pobrania uprawnień do identyfikatorów idSiscROF/idSiscROP/idSiscP z
powodu braku połączenia z systemem PDR.
2.4. E004 - MimeType is empty. Document will not be processed. - Brak zdeklarowane
typu MIME
2.5. E005 - Communication error - błąd komunikacji z serwisami zewnętrznymi
UWAGA.
W przypadku, gdy Podmiot nie spodziewa się odpowiedzi od PUESC, to nie powinien
odpytywać interfejsu WS_PULL częściej niż raz na 5 minut. W przypadku nieuzasadnionego
obciążania tego interfejsu aplikacją Podmiotu mogą zostać podjęte kroki zmierzające do
ograniczenia dostępu/ruchu dla tego Podmiotu.
16 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
4. Operacje biznesowe: kierunek PUESC –> Podmiot
Zewnętrzny
System PUESC może realizować operacje biznesowe dostarczenia dokumentu do Systemu
Podmiotu Zewnętrznego wywołując usługę zaimplementowaną po jego stronie zgodnie ze
specyfikacją WS_PUSH.wsdl, a następnie wysyłając dokument do Systemu Podmiotu
Zewnętrznego, np. na URL https://6.6.6.6/wsImpl/DocumentHandlingSvc
UWAGA.
System PUESC może dokonać wysyłki do Systemu Podmiotu Zewnętrznego tylko wtedy,
gdy spełnione będą warunki:
1. Reprezentant Podmiotu Zewnętrznego zarejestrował adres URL usługi, login i hasło w
Systemie SZPROT odpowiednim wnioskiem rejestracyjnym. Podane podczas rejestracji
URL, login i hasło będą używane, jeśli Podmiot Zewnętrzny życzy sobie doręczenia
usługi w tym trybie. Login usługi WebService użyty będzie w profilu WS-Security jako
Username, a hasło odpowiednio zostanie użyte dla trybu PasswordDigest.
Jeśli Podmiot Zewnętrzny podał dodatkowo odcisk palca swojego certyfikatu SSL podczas
rejestracji SZPROT to odcisk klucza będzie brany pod uwagę podczas doręczenia i będzie
sprawdzany z aktualnym odciskiem certyfikatu tuż przed właściwym połączeniem.
2. System Podmiotu Zewnętrznego ma zainstalowany globalnie zaufany certyfikat SSL, o ile
adres URL podany podczas rejestracji w SZPROT zawiera protokół https. System
PUESC nie dokona wysyłki do zewnętrznej usługi posiadającej nieważny,
nieweryfikowany certyfikat SSL. Jeśli podano URL bez rozszerzenia SSL (np. http:// ) to
Podmiot Zewnętrzny ponosi ryzyko jawności transmisji.
3. System Podmiotu Zewnętrznego musi mieć otwarty ruch na wejściu na przyjmowanie
dokumentów od PUESC.
PUESC ma do dyspozycji jedną operację biznesową w stosunku do Systemu Podmiotu
Zewnętrznego, a mianowicie tylko przysłanie dokumentu.
17 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
4.1. Wysłanie dokumentu przez PUESC
Operacja ta jest realizowana metodą AcceptDocumentRequest interfejsu WS_PUSH.wsdl
Nośnikiem informacji (warstwą logiczną) jest obiekt „document” opisany dalej w specyfikacji i
dostępny w pliku WS_CHANNEL.xsd.
Po wywołaniu metody AcceptDocumentRequest następuje odesłanie synchroniczne
odpowiedzi w postaci AcceptDocumentResponse – nośnikiem odpowiedzi jest obiekt
„result” opisany dalej w specyfikacji i dostępny w pliku WS_CHANNEL.xsd.
Odesłany dokument zostaje automatycznie oznaczony jako 'pobrany', co oznacza, że nie
zostanie zwrócony poprzez metody GetNextDocument / GetNextDocumentIdSisc za
pośrednictwem usługi WS_PULL.
Poniższy rysunek przedstawia model transmisji w tym opisany w tym rozdziale.
System Podatnika to system podmiotu zewnętrznego.
<<Interface>>
AcceptDocument
AcceptDocumentClientImpl
-AcceptDocumentRequestClientImpl
-AcceptDocumentResponseClientImpl
WS_CHANNEL.xsd : document
WS_CHANNEL.xsd : result
-AcceptDocumentRequest
-AcceptDocumentResponse
18 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
5. Struktura danych: kierunek PUESC –> Podmiot
Zewnętrzny
PUESC komunikuje się z systemem Podmiotu Zewnętrznego za pomocą struktur danych
określonych w pliku WS_CHANNEL.xsd, pola struktur są zależne od kierunku przepływu
informacji.
PUESC dostarczy do interfejsu obiekt „document” do metody AcceptDocumentRequest
zgodny z następującą strukturą:
Element / Atrybut
document
- content
- content/@filename
- content/@mime
- dispatchId
- caseId
- personSISC
- middleSISC
- endSISC
- attachments
- targetSystems
Powtarzalność
1
1
1
1
1
0..1
1
1
1
0..1
0..1
Typ
documentType
contentType
string
mimeType
string
string
idSISC
idSISC
idSISC
attachmentsType
targetSystemsType
19 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18












/document – element główny, który zawiera wszystkie pozostałe elementy
/document/content – element zawierający właściwy plik, który ma zostać dostarczony
do systemu celnego
/document/content/<value> – zawartość binarna typu Base64
/document/content/@filename – nazwa pliku, typ znakowy o liczbie znaków
maksymalnie 128
/document/content/@mime – określenie typu MIME dla zawartości (pliku),
dopuszczalne wartości to „application/xml” „application/pdf” „other”
/document/dispatchId – System PUESC wypełnia to pole identyfikatorem wysyłki
pochodzącym z CRKiD
/document/caseId – System PUESC opcjonalnie wypełnia to pole identyfikatorem
sprawy z CRKiD
/document/personSISC – System PUESC wypełnia to pole identyfikatorem SISC
osoby (reprezentanta fizycznego), do którego jest skierowany dokument z
/document/content
/document/middleSISC – System PUESC wypełnia to pole identyfikatorem SISC
pośrednika np. agencji, w kontekście której dany dokument występuje
/document/endSISC – System PUESC wypełnia to pole identyfikatorem podmiotu
reprezentowanego, w kontekście którego występuje dany komunikat
/document/attachments – lista załączników poza dokumentem głównym, które należy
przesłać razem, np.: System PUESC chce dostarczyć podpisany plik XML, ale
dodatkowo w parze ma być plik PDF jako załącznik.
o /document/attachments/attachment/@filename – nazwa pliku (maksymalnie
128 znaków).
o /document/attachments/attachment/@mime – typ pliku (np. application/xml)
o /document/attachments/attachment/<value> – zakodowany przy użyciu
Base64 ciąg znaków będący binarną treścią załącznika
/document/targetSystems/…/system – System PUESC wypełnia to pole wartością
„PODMIOT”
W synchronicznej odpowiedzi AcceptDocumentResponse System Podmiotu Zewnętrznego
zwróci obiekt „result” zgodny z następującą strukturą:
20 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
Element / Atrybut
result
- sysRef
Powtarzalność
1
1
Typ
resultType
string


/result – element główny, który zawiera wszystkie pozostałe elementy
/result/sysRef – unikalny identyfikator dokumentu zwracany przez System Podmiotu
Zewnętrznego do PUESC o liczbie znaków maksymalnie 256
Jeśli system Podmiotu Zewnętrznego zwróci niepusty sysRef dokument uważany jest jako
odczytany. Dokument taki zostaje oznaczony w PUESC jako odczytany i nie nastąpi jego
kolejna wysyłka.
Ponadto istnieją struktury danych dla błędów biznesowych i technicznych, a mianowicie:
1. businessErrorType
2. techErrorType
Obie stryktury składają się z następujących elementów:
/error – element główny
/error/errorCode – identyfikator błędu
/error/errorDesc – opis błędu
Dla kierunku przepływu informacji od systemu PUESC do systemu Podmiotu Zewnętrznego,
system Podmiotu Zewnętrznego może odpowiedzieć następującymi błędami:
1. błędy biznesowe typu businessErrorType są ignorowane
2. błędy techniczne typu techErrorType (odpowiednio kod i opis)
2.1. E001 – malformed base64 content - zawartość nie jest zakodowana w formacie
Base64
2.2. E002 – mime does not match with content - deklarowany typ MIME nie zgadza się z
zawartością
2.3. E003 – other error - błąd innego rodzaju
21 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
Jeśli wystąpi błąd techniczny typu E00x to System PUESC uzna dokument za
niedostarczony, tak samo, jakby otrzymał odpowiedz HTTP_404 od systemu Podmiotu
Zewnętrznego.
Jeżeli PUESC nie dostarczył komunikatu do Podmiotu lub gdy Podmiot go nie odebrał, to
jest możliwość jego pobrania z wykorzystaniem kanału WS_PULL (metody:
GetNextDocument, GetNextDocumentSisc, GetDocuments).
22 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
6. Diagram struktury WS_CHANNEL.xsd
23 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
24 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
Przykłady:
1. Dostarczenie dokumentu do SEAP i wysłanie do dwóch systemów dziedzinowych
<document xmlns="http://www.mf.gov.pl/schematy/SISC/WsChannel/2014/01_v2_0">
<content filename="filename1.xml" mime="application/xml">ZGVmYXVsdA==</content>
<targetSystems>
<system>SZPROT</system>
<system>OSOZ2</system>
</targetSystems>
</document>
2. Dostarczenie dokumentu od SEAP i wysłanie do podatnika
<document xmlns="http://www.mf.gov.pl/schematy/SISC/WsChannel/2014/01_v2_0">
<content filename="filename1.xml" mime="application/xml">ZGVmYXVsdA==</content>
<dispatchId>9989894ss0</dispatchId>
<caseId>PL/SPRAWA/1/2014</caseId>
<targetSystems>
<system>PODMIOT</system>
</targetSystems>
</document>
25 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
7. Przepływ dokumentów - Komunikaty
W trakcie komunikacji pomiędzy systemem zewnętrznym Podmiotu a systemem
dziedzinowym SISC (poprzez PUESC) przesyłane są komunikaty informujące o statusie
odebrania czy doręczenia dokumentów. Są to:
1. UPD – Urzędowe Poświadczenie Doręczenia – komunikat wysyłany przez system
PUESC do systemu zewnętrznego Podmiotu jako poświadczenie doręczenia dokumentu;
komunikat ten musi być podpisany przez Podmiot (podpisem kwalifikowanym lub
podpisem niekwalifikowanym celnym) i odesłany do systemu PUESC,
2. PND – Poświadczenie Niedoręczenia Dokumentu – komunikat wysyłany przez system
PUESC do systemu dziedzinowego SISC jako poświadczenie niedoręczenia dokumentu
do Podmiotu; komunikat jest wysyłany w sytuacji kiedy Podmiot nie odesłał do systemu
PUESC podpisanego komunikatu UPD, w ciągu 14 dni od doręczenia,
3. UPP – Urzędowe Poświadczenie Przedłożenia – komunikat wysyłany przez system
PUESC do systemu zewnętrznego Podmiotu jako poświadczenie przedłożenia
dokumentu; opcjonalnie komunikat ten może być również wysłany do systemu
dziedzinowego SISC,
4. NPP – Poświadczenie Nieprzedłożenia Dokumentu – komunikat wysyłany przez
system PUESC do systemu zewnętrznego Podmiotu lub do systemu dziedzinowego
SISC jako poświadczenie nieprzedłożenia dokumentu; komunikat jest wysyłany w
sytuacji kiedy Podmiot lub system dziedzinowy SISC wysłał do systemu PUESC
dokument, który w trakcie walidacji został uznany za nieprawidłowy (niezgodny z
odpowiednim schematem XSD lub niepodpisany kiedy jest to wymagane).
Przepływy komunikatów pomiędzy systemami są pokazane poglądowo na diagramach
poniżej.
26 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
1. Wysłanie dokumentu: System zewnętrzny Podmiotu – System dziedzinowy SISC
27 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
2. Wysłanie odpowiedzi: System dziedzinowy SISC – System zewnętrzny Podmiotu
28 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
8. Przepływ dokumentów - Komunikaty – Dodatkowe
elementy XML
Struktura komunikatów informujących o statusie odebrania czy doręczenia dokumentów jest
zgodna z określonym schematem XSD (plik schematUPO.xsd). Schemat XSD określa
podstawowe elementy konieczne do wymiany informacji pomiędzy systemami. W schemacie
XSD przewidziano możliwość obsługi przez system PUESC dodatkowych danych
(elementów XML).
Do
przekazywania
dodatkowych
danych
wykorzystywany
jest
<InformacjaUzupelniajaca>, wraz z atrybutem TypInformacjiUzupelniajacej.
element
Zestawienie poniżej przedstawia dodatkowe dane dla poszczególnych komunikatów.
Komunikat UPD.
Wszystkie dane umieszczone w elemencie <UPD>.
Dodatkowe dane w komunikacie XML (nazwa atrybutu typInformacjiUzupelniajacej, wartość):






nazwa="typPowiadomienia", wartość: "Urzędowe Poświadczenie Doręczenia"
nazwa="skrotDokumentu", wartość to wygenerowany skrót SHA1 dla dokumentu
nazwa="idDokumentuSEAP", wartość to wewnętrzny identyfikator dokumentu w
systemie SEAP (PUESC)
nazwa="idDokumentuSystemZewnetrzny", wartość to wewnętrzny identyfikator
dokumentu w systemie zewnętrznym
nazwa="idSprawySystemZewnetrzny", wartość to wewnętrzny identyfikator sprawy w
systemie zewnętrznym
nazwa="idWysylkiDokumentu", wartość to wewnętrzny identyfikator wysyłki dla
dokumentu w systemie SEAP (PUESC)
29 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
Przykład:
<pos:UPD>
<pos:InformacjaUzupelniajaca typInformacjiUzupelniajacej="typPowiadomienia">
Urzędowe Poświadczenie Doręczenia
</pos:InformacjaUzupelniajaca>
</pos:UPD>
Komunikat PND.
Wszystkie dane umieszczone w elemencie <UPD>.






nazwa="typPowiadomienia", wartość: "Poświadczenie Niedoręczenia Dokumentu"
nazwa="idWysylkiDokumentu", wartość to wewnętrzny identyfikator wysyłki dla
Przykład:
<pos:UPD>
Poświadczenie Niedoręczenia Dokumentu
</pos:UPD>
Komunikat UPP.
Wszystkie dane umieszczone w elemencie <UPP>.
30 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18






nazwa="typPowiadomienia", wartość: "Urzędowe Poświadczenie Przedłożenia"
nazwa="idWpływuDokumentu", wartość to wewnętrzny identyfikator wpływu dla
Przykład:
<pos:UPP>
Urzędowe Poświadczenie Przedłożenia
</pos:UPP>
Komunikat NPP.
Wszystkie dane umieszczone w elemencie <UPP>.






nazwa="typPowiadomienia", wartość: "Poświadczenie Nieprzedłożenia Dokumentu"
nazwa="PrzyczynaBledu", wartość to opis przyczyny błędu, który wystąpił podczas
walidowania dokumentu
31 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
Przykład:
<pos:UPP>
Poświadczenie Nieprzedłożenia Dokumentu
</pos:UPP>
Dzięki wykorzystaniu dodatkowych danych można określić dokładnych typ powiadomienia
oraz powiązać komunikat z dokumentem, którego dany komunikat dotyczy (np. poprzez
wykorzystanie skrótu dokumentu).
32 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
9. Często zadawane pytania, FAQ
9.1. Jaki standard WS-Security należy użyć?
Interfejs obsługuje profil UsernameToken w trybie PasswordDigest. Używa to tego tzw.
nonce+created. Ponadto interfejs wymaga włączonej obsługi WS-Addressing.
9.2. Czy można wysyłać wiadomości do PUESC bez użycia SSL?
Nie. Tylko https.
9.3. Co to jest idSISC w szczególności pierwsze, drugie i trzecie?
idSISC to identyfikator użytkownika w ramach Systemu Informacyjnego Służby Celnej, w
szczególności:
 idSiscP - idSISC podmiotu
 idSiscROP - idSISC podmiotu pośredniczącego
 idSiscROF - idSISC osoby fizycznej
9.4. Co można zrobić z otrzymanym identyfikatorem sysRef?
Można go użyć we własnej aplikacji do śledzenia dokumentów, np. do ewidencjonowania
przyjęć przez PUESC.
9.5. Co jeśli nie jest znana nazwa użytkownika i hasło do
podłączenia się po WS-Security?
Należy założyć konto w Portalu https://puesc.gov.pl/ login i hasło są jednocześnie nazwą
użytkownika i hasłem do WS-Security
33 z 34
www.e-clo.gov.pl
Wersja: 20.0
Data: 2016-01-18
9.6. Co jeśli używamy WS_PUSH.wsdl i zmieniliśmy certyfikat
SSL?
Należy przeprowadzić aktualizacje danych w SZPROT i umieścić tam nowy odcisk
certyfikatu SSL.
34 z 34
www.e-clo.gov.pl

SEAP Specyfikacja XML v. 20.0

Transkrypt

Podobne dokumenty

SEAP specyfikacja XML

załącznik nr 6 – SEAP specyfikacja

Biuletyn - Mayors in Action

Instrukcja - deklaracje podatkowe zapłata akcyzy

Ocena jakości wody- SUW Rzepin ul. Malinowa 07-2016 - Eko