Spis treści INTERFEJS (WEBSERVICES) - DOKUMENTACJA TECHICZNA 1

Transkrypt

1 I N T E R F E J S W E BSERVICES NADAWANIE PAKIETÓW DO S YSTEMU MKP P RZEZ INTERNET D O K U M E N T A C J A T E C H N I C Z N A S T Y C Z E Ń

2 Spis treści 1. Wstęp Informacje ogólne Definicje Wyliczenia RodzajUslugi StanPakietu RodzajDokumentu StanOplacenia StanuPakietu KategoriaBledu KodBledu Struktury Pakietu Dokumentu OpiStanuOplacenia ListaZnalezionychPakietow Bledu Metody Utworzenie pakietu plikowego Pobranie informacji o pakiecie Usunięcie wskazanego pakietu Zatwierdzenie zarejestrowanego pakietu Wyszukiwanie pakietów Pobranie listy dokumentów Pobranie dokumentu Zlecenie sprawdzenia stanu opłacenia Sprawdzenie stanu opłacenia pakietu INTERFEJS (WEBSERVICES) - DOKUMENTACJA TECHICZNA 1

3 1. Wstęp Niniejszy dokument specyfikuje interfejs API usług sieciowych (WebServices) umożliwiający nadawanie pakietów do systemu MKP za pośrednictwem publicznego Internetu. Interfejs usług sieciowych umożliwia: zarejestrowanie pakietu plikowego w systemie MKP, wyszukiwanie zarejestrowanych przez siebie pakietów, zatwierdzenie wybranego pakietu, usunięcie wybranego pakietu, pobieranie dokumentów związanych z pakietem wygenerowanych przez system MKP, sprawdzenie stanu opłacenia pakietu. 2. Informacje ogólne Usługi dostępne są pod adresem: polska.pl/mkpwww/uslugi/obslugapakietow.svc Do korzystania z usług wymagana jest rejestracja w serwisie: polska.pl/ Szczegółowa specyfikacja WSDL dostępna jest pod adresem: polska.pl/mkpwww/uslugi/obslugapakietow.svc?wsdl Do dostępu do usługi wykorzystywane jest połączenie HTTPS z wiązaniem WCF basichttpbinding z trybem zabezpieczeń TransportWithMessageCredential i trybem przekazania danych uwierzytelniających UserName. Nazwa użytkownika i hasło (zgodne z rejestracją w serwisie) przekazywane są w nagłówkach komunikatu SOAP w tunelu SSL/TLS. W przypadku wykrycia nadmiernego obciążania serwera wywołaniami niniejszego API zamiast wyspecyfikowanych komunikatów mogą być zwracane niskopoziomowe błędy na poziomie protokołu HTTP lub SOAP (np. błąd uwierzytelnienia dla obciążającego użytkownika pomimo przekazania poprawnego hasła). INTERFEJS (WEBSERVICES) - DOKUMENTACJA TECHICZNA 2

4 3. Definicje Poniższe API wykorzystuje przestrzeń nazw komunikatów: " Wyliczenia RodzajUslugi public enum RodzajUslugi PZW, //Ekspres pieniężny (EP-PZW) PPE, //Przekaz pocztowy StanPakietu public enum StanPakietu NIEOBSLUGIWANY, Otwarty, UtworzonyCzekaNaWeryfikacjeMKP, OdrzuconyZPowoduBleduWeryfikacji, ZweryfikowanyOczekujacyNaZatwierdzenie, Zamkniety, RodzajDokumentu public enum RodzajDokumentu NIEOBSLUGIWANY, RaportKontroliFormalnej, WykazBledow, PocztowaKsiazkaNadawcza, RaportStanuRealizacji, SpecyfikacjaZwrotowZadanieZwrotu, SpecyfikacjaZwrotowZwrotyPrzekazow, INTERFEJS (WEBSERVICES) - DOKUMENTACJA TECHICZNA 3

5 SpecyfikacjaZwrotowPrzeterminowanie, SpecyfikacjaZwrotowNadwyzka, StanOplacenia public enum StanOplacenia NIEOBSLUGIWANY, ZlecenieOczekujeNaSprawdzenie, BrakPakietu, BrakWplaty, WplataZgodna, WplataNiezgodna, StanuPakietu public enum StanuPakietu NIEOBSLUGIWANY, Zarejestrowany, Oplacony, Uniewazniony, Przeterminowany, KategoriaBledu public enum KategoriaBledu NIEOBSLUGIWANY, BladWywolania, BladNaSerwerze, INTERFEJS (WEBSERVICES) - DOKUMENTACJA TECHICZNA 4

6 KodBledu public enum KodBledu NIEOBSLUGIWANY, BladStrukturyKomunikatu, BladPrzekroczeniaOgraniczenCzestotliwosciWywolan, BledneDaneDoUtworzeniaPakietu, BlednyIdentyfikatorPakietu, BlednyIdentyfikatorDokumentu, StanPakietuNieodpowiedniDoZadanejOperacji, BrakPakietuDlaIdentyfikatora, BrakDokumentuDlaIdentyfikatora, BrakZadaniaSprawdzeniaStanuDlaIdentyfikatora, KomunikatBiznesowy, 3.2. Struktury Pakietu uje zarejestrowany pakiet. Część atrybutów dostępna jest tylko dla pakietów zamkniętych zgodnie z opisem poniżej. public class Pakietu public string UIP get; set; public RodzajUslugi Usluga get; set; public string NazwaPliku get; set; public StanPakietu Stan get; set; INTERFEJS (WEBSERVICES) - DOKUMENTACJA TECHICZNA 5

7 //INFO: data bez czasu public DateTime DataUtworzenia get; set; public string NumerUmowy get; set; public decimal ProcentOpustu get; set; //INFO: wszystko poniżej wypełniane tylko dla stanu 'Zamkniety' [DataMember(IsRequired = false)] public int LiczbaPrzekazowPoprawnych get; set; [DataMember(IsRequired = false)] public decimal WartoscPrzekazowPoprawnych get; set; [DataMember(IsRequired = false)] public decimal OplataZaNadanie get; set; [DataMember(IsRequired = false)] public string NumerRachunkuBankowegoWplaty get; set; [DataMember(IsRequired = false)] public DateTime DataGranicznaWplaty get; set; Dokumentu uje dokument dotyczący zarejestrowanego pakietu. public class Dokumentu public string Identyfikator get; set; public RodzajDokumentu Rodzaj get; set; public DateTime DataUtworzenia get; set; public string NazwaPliku get; set; INTERFEJS (WEBSERVICES) - DOKUMENTACJA TECHICZNA 6

8 OpiStanuOplacenia uje stan opłacenia pakietu. Część atrybutów dostępna jest tylko dla pakietów sparowanych zgodnie z opisem poniżej. public class StanuOplacenia public StanOplacenia Stan get; set; [DataMember(IsRequired = false)] public StanuPakietu StanPakietu get; set; //INFO: wszystko poniżej wypełniane tylko dla stanu różnego od 'BrakWplaty' [DataMember(IsRequired = false)] public DateTime DataSparowania get; set; ListaZnalezionychPakietow Zawiera listę znalezionych pakietów wraz z ewentualną informacją o przekroczeniu limitu zwracanych danych. public class ListaZnalezionychPakietow public Pakietu[] ListaPakietow get; set; [DataMember(IsRequired = false)] public bool ListaPakietowOgraniczonaZPowoduPrzekroczeniaLimitu get; set; Bledu uje rodzaj zwracanego błędu. Poza komunikatem tekstowym zwracana jest ogólna kategoria błędu (błąd wywołania ze strony klienta, błąd po stronie serwera) oraz kod błędu z predefiniowanej listy. public class Bledu public KategoriaBledu Kategoria get; set; public KodBledu Kod get; set; [DataMember] public string Komunikat get; set; INTERFEJS (WEBSERVICES) - DOKUMENTACJA TECHICZNA 7

9 4. Metody 4.1. Utworzenie pakietu plikowego Metoda służy do utworzenia pakietu poprzez wczytanie pliku z przekazami / zleceniami. Pakiet po utworzeniu oczekuje na asynchroniczne wykonanie przez system MKP kontroli formalnej pliku. Wynik kontroli formalnej można zweryfikować za pomocą metody DajPakiet. [FaultContract(typeof(Bledu))] [return: MessageParameter(Name = "UIP")] string UtworzPakiet( [MessageParameter(Name = "RodzajUslugi")] RodzajUslugi rodzajuslugi, [MessageParameter(Name = "NazwaPliku")] string nazwapliku, [MessageParameter(Name = "ZawartoscPliku")] byte[] bajtypliku, [MessageParameter(Name = "ZatwierdzenieAutomatyczne")] bool zatwierdzenieautomatyczne) ; Parametr RodzajUslugi NazwaPliku BajtyPliku ZatwierdzenieAutomatyczne Rodzaj usługi, dla której tworzony jest pakiet. Nazwa pliku z przekazami / zleceniami. Zawartość pliku. Żądanie automatycznego zatwierdzenia pakietu po kontroli formalnej pliku (pakiet zostanie automatycznie zatwierdzony tylko w przypadku poprawnego przejścia kontroli formalnej pliku). Nazwa UIP Identyfikator utworzonego pakietu. INTERFEJS (WEBSERVICES) - DOKUMENTACJA TECHICZNA 8

10 4.2. Pobranie informacji o pakiecie Metoda służy do pobrania informacji o zarejestrowanym pakiecie. [FaultContract(typeof(Bledu))] [return: MessageParameter(Name = "Pakiet")] Pakietu DajPakiet( [MessageParameter(Name = "UIP")] string UIP); Nazwa UIP Identyfikator utworzonego pakietu. Nazwa Pakietu Struktura zawierająca opis zarejestrowanego pakietu. W przypadku podanie błędnego identyfikatora pakietu zwracany jest kod błędu: BlednyIdentyfikatorPakietu. W przypadku braku pakietu zwracany jest kod błędu: BrakPakietuDlaIdentyfikatora. INTERFEJS (WEBSERVICES) - DOKUMENTACJA TECHICZNA 9

11 4.3. Usunięcie wskazanego pakietu Metoda służy do usuwanie zarejestrowanego pakietu. Można usunąć tylko pakiet o stanie innym niż Zamknięty. [FaultContract(typeof(Bledu))] void UsunPakiet( [MessageParameter(Name = "UIP")] string UIP); Nazwa UIP Identyfikator utworzonego pakietu. (brak) W przypadku podanie błędnego identyfikatora pakietu zwracany jest kod błędu: BlednyIdentyfikatorPakietu. W przydaku gdy nie można usunąć pakietu ze względu na błedny stan, zwracany jest kod błędu: StanPakietuNieodpowiedniDoZadanejOperacji. W przypadku braku pakietu zwracany jest kod błędu: BrakPakietuDlaIdentyfikatora. INTERFEJS (WEBSERVICES) - DOKUMENTACJA TECHICZNA 10

12 4.4. Zatwierdzenie zarejestrowanego pakietu Metoda służy do pobrania informacji o zarejestrowanym pakiecie. [FaultContract(typeof(Bledu))] void ZatwierdzPakiet( [MessageParameter(Name = "UIP")] string UIP); Nazwa UIP Identyfikator utworzonego pakietu (brak) W przypadku podanie błędnego identyfikatora pakietu zwracany jest kod błędu: BlednyIdentyfikatorPakietu. W przypadku braku pakietu zwracany jest kod błędu: BrakPakietuDlaIdentyfikatora. W przypadku próby zamkniecia pakietu o niedozwolonym stanie zwracany jest kod błedu: StanPakietuNieodpowiedniDoZadanejOperacji. INTERFEJS (WEBSERVICES) - DOKUMENTACJA TECHICZNA 11

13 4.5. Wyszukiwanie pakietów Metoda służy do wyszukiwania zarejestrowanych pakietów. [FaultContract(typeof(Bledu))] [return: MessageParameter(Name = "ListaZnalezionychPakietow")] ListaZnalezionychPakietow ZnajdzPakiety( [MessageParameter(Name = "ListaStanow")] [Optional] StanPakietu[] listastanow, [MessageParameter(Name = "DataOd")] [Optional] DateTime? dataod, [MessageParameter(Name = "DataDo")] [Optional] DateTime? datado, [MessageParameter(Name = "Usluga")] [Optional] RodzajUslugi? usluga ); Parametr ListaStanow DataOd, DataDo Usluga Opcjonalny filtr na StanPakietu. Opcjonalny zakres dat, dla którego prowadzone jest wyszukiwanie. Opcjonalny filtr na RodzajUslugi. Nazwa ListaZnalezionychPakietow Struktura zawierająca listę znalezionych pakietów. Lista zwracanych pakietów ograniczana jest na serwerze do pewnej konfigurowalnej liczby (rzędu kilkuset). W przypadku gdy lista znalezionych pakietów przekroczy ustawiony limit w zwracanym komunikacie ustawiany jest atrybut ListaPakietowOgraniczonaZPowoduPrzekroczeniaLimitu, aby zasygnalizować, że nie zostały zwrócone kompletne wyniki i należy zawęzić kryteria. INTERFEJS (WEBSERVICES) - DOKUMENTACJA TECHICZNA 12

14 4.6. Pobranie listy dokumentów Metoda służy do pobrania listy dokumentów dla wskazanego pakietu. [FaultContract(typeof(Bledu))] [return: MessageParameter(Name = "ListaDokumentow")] Dokumentu[] DajDokumenty( [MessageParameter(Name = "UIP")] string UIP, [MessageParameter(Name = "RodzajeDokumentow")] RodzajDokumentu[] rodzaje ); Parametr UIP Rodzaje Identyfikator pakietu. Opcjonalny filtr na RodzajDokumentu. Nazwa ListaDokumentow Struktura zawierająca listę znalezionych dokumentów. W przypadku podanie błędnego identyfikatora pakietu zwracany jest kod błędu: BlednyIdentyfikatorPakietu. W przypadku braku pakietu zwracany jest kod błędu: BrakPakietuDlaIdentyfikatora. INTERFEJS (WEBSERVICES) - DOKUMENTACJA TECHICZNA 13

15 4.7. Pobranie dokumentu Metoda służy do pobrania treści wskazanego dokumentu. [FaultContract(typeof(Bledu))] [return: MessageParameter(Name = "ZawartoscDokumentu")] byte[] DajTrescDokumentu( [MessageParameter(Name = "IdentyfikatorDokumentu")] string id); Parametr IdentyfikatorDokumentu Identyfikator dokumentu. Nazwa ZawartoscDokumentu Zawartość pobieranego dokumentu Zlecenie sprawdzenia stanu opłacenia Metoda służy do zlecenia sprawdzenia stanu opłacenia pakietu. [FaultContract(typeof(Bledu))] void ZlecSprawdzenieStanuOplacenia( [MessageParameter(Name = "UIP")] string UIP); Parametr UIP Identyfikator pakietu. W przypadku podanie błędnego identyfikatora pakietu zwracany jest kod błędu: BlednyIdentyfikatorPakietu. INTERFEJS (WEBSERVICES) - DOKUMENTACJA TECHICZNA 14

16 4.9. Sprawdzenie stanu opłacenia pakietu Metoda służy o pobrania informacji o stanie pakietu dla złożonego wcześniej zlecenia. [FaultContract(typeof(Bledu))] [return: MessageParameter(Name = "StanOplaceniaPakietu")] StanuOplacenia DajStanOplacenia( [MessageParameter(Name = "UIP")] string UIP); Parametr UIP Identyfikator pakietu. Parametr StanOplaceniaPakietu stanu opłacenia pakietu. W przypadku podanie błędnego identyfikatora pakietu zwracany jest kod błędu: BlednyIdentyfikatorPakietu. W przypadku gdy nie znaleziono zlecenie zwracany jest kod błędu: BrakZadaniaSprawdzeniaStanuDlaIdentyfikatora. INTERFEJS (WEBSERVICES) - DOKUMENTACJA TECHICZNA 15