# Webová služba Certificate verze 6.0.0 (Obecné webové služby) - popis rozhraní služby

Marbes Consulting s.r.o.

EOS4

Vygenerováno z verze 4.21.0.19.0.

Podmínky omezující zveřejnění

Autorem tohoto dokumentu je společnost MARBES CONSULTING s.r.o. Dokument obsahuje informace důvěrného charakteru a ve smyslu definice autorského práva (viz § 2, odst. 1 Zákona č. 121/2000 Sb., zákon o právu autorském) je duševním vlastnictvím autora a předmětem práva autorského. Dokument smí být použit výhradně za účelem, za kterým byl poskytnut a nesmí být bez předchozího souhlasu autora citován, kopírován, vytěžován1 nebo předán třetí fyzické či právnické osobě.

© 2009 MARBES CONSULTING s.r.o.

1 Vytěžováním se podle zákona č. 121/2000 Sb. rozumí trvalý nebo dočasný přepis celého obsahu nebo jeho podstatné části na jiný podklad, a to jakýmikoli prostředky nebo jakýmkoli způsobem.

## Obsah

- Obecné informace
- Seznam poskytovaných metod
- Seznam struktur dat
- Výjimky
- Popis poskytovaných metod
- Popis struktur dat

## Obecné informace

Webová služba pro správu certifikátů v EOS.

## Seznam poskytovaných metod

Název | Popis
--- | ---
getAllCertificates |
getAllowedCertificateIssuers | Vrátí seznam vydavatelů certifikátů od kterých chceme importovat certifikáty.
getNextCertificates |
importCertificateInfo | Metoda pro aktualizaci nebo import certifikátů do EOS.
isCertificateImportEnable | Zjistí, jestli je povolen import certifikátů přes webovou službu.

## Seznam struktur dat

Název | Popis
--- | ---
EosAllowedIssuers | Seznam vydavatelů certifikátů od kterých chceme importovat certifikáty.
EosCertificate | WS objekt certifikátu se základními údaji o certifikátu.
EosCertificateAdministrator |
EosCertificateAdministrators |
EosCertificatePerson |
EosCertificatePersons |
EosCertificateWrapper |
EosCertificateWrappers |
EosCertificates | Objekt obsahuje seznam certifikátů.
EosPaging | Objekt obsahující informace pro stránkování.

## Výjimky

### EosCertificateImportDisabledException

Výjimka vyvolána, pokud je vyvolána služba importu certifikátů, i když je zakázán v nastavení.

### EosInternalException

Neočekávaná výjimka při volání webových služeb.

### EosObjectNotFoundException

Objekt nebyl nalezen.

### EosSessionNotFoundException

Session s předaným id nebyla nalezena.

## Popis poskytovaných metod

### getAllCertificates

#### Předpis

EosCertificateWrappers getAllCertificates (String sid)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
sid | String | Ne |

#### Výstup

EosCertificateWrappers -

#### Výjimky

EosSessionNotFoundException -

### getAllowedCertificateIssuers

Vrátí seznam vydavatelů certifikátů od kterých chceme importovat certifikáty.

#### Předpis

EosAllowedIssuers getAllowedCertificateIssuers ()

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---

#### Výstup

EosAllowedIssuers - seznam vydavatelů certifikátů od kterých chceme importovat certifikáty

#### Výjimky

EosInternalException - vnitřní chyba systému v eos

### getNextCertificates

#### Předpis

EosCertificateWrappers getNextCertificates (String sid, String lid)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
sid | String | Ne |
lid | String | Ano |

#### Výstup

EosCertificateWrappers -

#### Výjimky

EosSessionNotFoundException -

### importCertificateInfo

Metoda pro aktualizaci nebo import certifikátů do EOS. Pro správnou funkci metody musí být v EOS nastavení povolen import certifikátů!
Certifikáty jsou porovnávány podle uniqueKey klíče.

- Pokud je certifikát v databázi, proběhne pouze aktualizace počtu dní k upozornění před vypršením platnosti.
- Pokud certifikát v databázi ještět není, je vytvořen ze získaných dat a jeho správci jsou ti, kteří jsou určeni v nastavení EOS

#### Předpis

void importCertificateInfo (EosCertificates certificates)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
certificates | EosCertificates | Ano | seznam certifikátů pro aktualizaci / import

#### Výjimky

EosInternalException - vnitřní chyba systému v eos
EosCertificateImportDisabledException - pokud není povolen import certifikátů
EosObjectNotFoundException - pokud není nalezena osoba certifikátu v EOS

### isCertificateImportEnable

Zjistí, jestli je povolen import certifikátů přes webovou službu. Import certifikátů se nastavuje v obecném nastavení EOSU.

#### Předpis

boolean isCertificateImportEnable ()

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---

#### Výstup

boolean - true, pokud je import povolen, jinak false

#### Výjimky

EosInternalException - vnitřní chyba systému v eos

## Popis struktur dat

### EosAllowedIssuers

Seznam vydavatelů certifikátů od kterých chceme importovat certifikáty.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
allowedIssuers | List<String> | Ne |

### EosCertificate

WS objekt certifikátu se základními údaji o certifikátu.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
name | String | Ne | Název certifikátu.
validFrom | Date | Ne | Datum, od kterého (včetně) je certifikát platný.
validTo | Date | Ne | Datum, do kterého (včetně) je certifikát platný.
certificateFileName | String | Ne | Soubor certifikátu.
certificatePersonId | String | Ne | Osoba přiřazená k certifikátu.
uniqueKey | String | Ne | Unikátní klíč certifikátu.
issuer | String | Ne | Vydavatele
subject | String | Ne | Subjekt certifikátu.
serialNumber | String | Ne | Sériové číslo.
signatureAlg | String | Ne | Algoritmus podpisu
publicKeyAlg | String | Ne | Algoritmus veřejného klíče.
publicKeyFormat | String | Ne | Formát veřejnéhjo klíče.
version | Integer | Ne | Verze
certEncoded | byte | Ne |

### EosCertificateAdministrator

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
login | String | Ne |
eosId | String | Ne |
name | String | Ne |
surname | String | Ne |
displayName | String | Ne |

### EosCertificateAdministrators

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
administrators | List<EosCertificateAdministrator> | Ne | Správci

### EosCertificatePerson

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
login | String | Ne |
eosId | String | Ne |
name | String | Ne |
surname | String | Ne |
displayName | String | Ne |

### EosCertificatePersons

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
persons | List<EosCertificatePerson> | Ne | Osoby

### EosCertificateWrapper

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
id | Long | Ne | Id certifikátu.
name | String | Ne | Název certifikátu.
description | String | Ne | Popis certifikátu.
contact | String | Ne | Kontakt
certificateFileName | String | Ne | Soubor certifikátu.
validFrom | Date | Ne | Datum, od kterého (včetně) je certifikát platný.
validTo | Date | Ne | Datum, do kterého (včetně) je certifikát platný.
synchronize | Boolean | Ne | Synchronizováno
type | String | Ne | Typ certifikátu
insertDate | Date | Ne | Datum vložení
uniqueKey | String | Ne | Unikátní klíč certifikátu.
issuer | String | Ne | Vydavatele
subject | String | Ne | Subjekt certifikátu.
serialNumber | String | Ne | Sériové číslo.
signatureAlg | String | Ne | Algoritmus podpisu
publicKeyAlg | String | Ne | Algoritmus veřejného klíče.
publicKeyFormat | String | Ne | Formát veřejnéhjo klíče.
version | Integer | Ne | Verze
revocationDate | Date | Ne | Datum zneplatnění
revocationPassword | String | Ne | Heslo zneplatnění
revocationReason | String | Ne | Důvod zneplatnění
certificatePersons | EosCertificatePersons | Ne | Osoba certifikátu
certificateAdministrators | EosCertificateAdministrators | Ne | Správci certifikátu
synchronizeJIP | Boolean | Ne | Synchronizovat do JIP

### EosCertificateWrappers

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
wrappers | List<EosCertificateWrapper> | Ne | Ceritifikáty.
paging | EosPaging | Ne | Stránkování.

### EosCertificates

Objekt obsahuje seznam certifikátů.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
certificate | List<EosCertificate> | Ne | Seznam certifikátů.

### EosPaging

Objekt obsahující informace pro stránkování.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
lid | String | Ne | List id nebo null, pokud stránkování není vyžadováno.
start | int | Ne | Index prvního záznamu, který byl aktuálně vrácen.
totalCount | int | Ne | Celkový počáteční záznamů.
hasNext | boolean | Ne | Příznak, zda jsou k dispozici ještě další záznamy.