Autorizovaná konverze do elektronické podoby – inicializace

Metoda webové služby ConvertToDigital slouží pro Autorizovanou konverzi dokumentu z listinné podoby do elektronické – inicializaci konverze. Tento požadavek je nutné ukončit voláním metody FinalizeConvertToDigital.

Metoda vyžaduje autentizaci uživatele, který je autorizován pro použití systému CzechPOINT, na základě uživatelského jména a nastaveného autentizačního certifikátu pro AIS (Agendový informační systém) organizace.

Pro úspěšné dokončení autorizované konverze z listinné podoby do elektronické je nutným předpokladem předávání HTTP headeru Cookie s ASP.NET_SessionId mezi inicializací a finalizací.

Mezi inicializací (ConvertToDigital) a finalizací (FinalizeConvertToDigital) konverze je zapotřebí elektronicky podepsat dokument, který byl vrácen ve výstupu služby (ConvertToDigitalResponse), certifikátem uživatele, který autorizovanou konverzi provedl. Pro elektronický podpis lze využít např. Signer WebAPI. Toto platí pouze v případě Autorizované konverze do elektronické podoby.

Popis služby ConvertToDigital včetně WSDL schématu a příklad požadavku a odpovědi pro SOAP 1.1 a SOAP 1.2 je umístěn na http://localhost/ltd/ltd.asmx?op=ConvertToDigital.

localhost je název používaný pro lokální počítač; namísto něj zvolte jméno/IP adresu LTD serveru (dle nastavení v IIS).

SOAP 1.1

Požadavek

POST /ltd/ltd.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://software602.com/longtermdocs/ConvertToDigital"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ConvertToDigital xmlns="http://software602.com/longtermdocs/">
      <Options>
        <InputName>string</InputName>
        <InputData>Base64Binary</param>
        <JipUsername>string</param>
        <GetHtmlSummary>boolean</param>
        <GetPdfSummary>boolean</param>
        <Security>
          <Watermark>boolean</Watermark>
          <EmbossedPrinting>boolean</EmbossedPrinting>
          <Embossing>boolean</Embossing>
          <DrySeal>boolean</DrySeal>
          <EmbossedFabrication>boolean</EmbossedFabrication>
          <OpticalVariableElement>boolean</OpticalVariableElement>
          <Other>boolean</Other>
        </Security>
        <CustomSecurityElements>
          <string>string</string>
          <string>string</string>
        </CustomSecurityElements>
        <InputDescription>string</InputDescription>
      </Options>
    </ConvertToDigital>
  </soap:Body>
</soap:Envelope>

<InputName>

Vstup Popis

String

Název konvertovaného souboru. Z přípony souboru v názvu je odvozený typ vstupu. Na vstupu jsou povolené pouze PDF soubory nebo datové zprávy (ZFO).

<InputData>

Vstup Popis

Base64Binary

Base64Binary data zkonvertovaného PDF souboru v PDF/A formátu.

<JipUsername>

Vstup Popis

String

Jméno uživatele, pod kterým se webová služba přihlašuje do rozhraní KZMU pro získání unikátního ID konverze.

<GetHtmlSummary>

Vstup Popis

Boolean

V případě úspěšné konverze bude odpověď obsahovat Base64Binary data doložky ve formátu HTML.

Nastavení tohoto parametru na true je povinné pro úspěšnou finalizaci konverze v autorizované konverzi. Pro automatizovanou je parametr volitelný a jeho hodnota je nastavena na false.

<GetPdfSummary>

Vstup Popis

Boolean

V případě úspěšné konverze bude odpověď obsahovat Base64Binary data doložky ve formátu PDF.

Pro automatizovanou konverzi je defaultně nastavena na true.

<Security>

<Watermark>

Vstup Popis

Boolean

Nutné nastavit v případě, že konvertovaný dokument obsahuje vodotisk.

<EmbossedPrinting>

Vstup Popis

Boolean

Nutné nastavit v případě, že konvertovaný dokument obsahuje reliéfní tisk.

<Embossing>

Vstup Popis

Boolean

Nutné nastavit v případě, že konvertovaný dokument obsahuje embossing.

<DrySeal>

Vstup Popis

Boolean

Nutné nastavit v případě, že konvertovaný dokument obsahuje suchou pečeť.

<EmbossedFabrication>

Vstup Popis

Boolean

Nutné nastavit v případě, že konvertovaný dokument obsahuje reliéfní ražbu.

<OpticalVariableElement>

Vstup Popis

Boolean

Nutné nastavit v případě, že konvertovaný dokument obsahuje opticky variabilní prvek.

<Other>

Vstup Popis

Boolean

Nutné nastavit v případě, že konvertovaný dokument obsahuje jiný zajišťovací prvek.

</Security>

<CustomSecurityElements> – pole stringů

<string>

Vstup Popis

String

Slouží pro definici vlastních bezpečnostních prvků, jiných, než které jsou uvedeny v Security. Provádí se základní kontrola na shodu, aby prvky v doložce nebyly duplikovány.

</CustomSecurityElements>

<InputDescription>

Vstup Popis

String

Slouží pro identifikaci vstupu obecným textem. Jedná se o „Označení vstupu“ (dle §26 písmene c zákona 300/2008 Sb.), který slouží pro uložení informace do Evidence provedených konverzí, která je součástí systému Czech POINT (KZMU úložiště). Vkládá se do doložky.

Pokud je specifikován, použije se namísto hodnoty InputName (kde je nutné uvést příponu formátu vstupu).

Odpověď

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ConvertToDigitalResponse xmlns="http://software602.com/longtermdocs/">
      <ConvertToDigitalResult>int</ConvertToDigitalResult>
      <Results>
        <Guid>string</Guid>
        <ErrorMessage>string</ErrorMessage>
        <HtmlSummary>string</HtmlSummary>
        <PdfSummary>string</PdfSummary>
        <OutputData>string</OutputData>
      </Results>
    </ConvertToDigitalResponse>
  </soap:Body>
</soap:Envelope>

<ConvertToDigitalResult>

Návratová hodnota Popis

Int

Kód chyby. 0 = v pořádku. Jinak viz kapitola Návratové kódy.

<Results>

<Guid>

Návratová hodnota Popis

String

Unikátní identifikátor konverze.

<ErrorMessage>

Návratová hodnota Popis

String

V případě problému obsahuje detail chyby.

<HtmlSummary>

Návratová hodnota Popis

String

Obsahuje HTML data doložky, pokud bylo zvoleno v požadavku.

Data jsou vyžadována pro finalizaci konverze – platí pouze v případě autorizované konverze.

<PdfSummary>

Návratová hodnota Popis

Base64Binary

Obsahuje Base64Binary data PDF doložky, pokud bylo zvoleno v požadavku.

<OutputData>

Návratová hodnota Popis

Base64Binary

Base64Binary data výstupního souboru s připojenou doložku ve formátu PDF/A-2b na konci dokumentu.

</Results>