Kihagyás

Sign API V1

HammySignAPI WSDL letöltése

Sign

PDF állományok digitális aláírását és időbélyegzését elvégző szolgáltatás.

Web service API

Kérés

Név Típus Leírás Kötelező
clientHashKey String A webszolgáltatást hívó kliens azonosítója. *
content Byte [ ] A pdf állomány, Base64 kódolva. *
keyAlias String Az aláíró kulcstárban az aláíró kulcs alias neve. *
pdfSigner String Az aláírást végző bean (osztály példány) neve. Default: corePdfSigner.
location String Az aláírás helye. Default: Budapest.
reason String Az aláírás célja.
timestampMode TimestampMode Az időbélyegzés módja. *
signImage SignImage_V1 Aláírási kép objektum
certificationLevelNoChangesAllowed Boolean Az aláírás szintje, további változtatás engedélyezett-e.
visibleSignatureEnabled Boolean Látható aláírásjelzés engedélyezett-e.
visibleSignatureVerification Boolean Látható aláírásérvényesség engedélyezett-e.
visibleSimpleImageEnabled Boolean Aláírási kép látható-e.
countryCode String Ország kódja.
password String Létrehozott PDF-et védő jelszó.
encryptOnly Boolean Csak jelszóval kell védeni a PDF-et, aláírni nem kell.

Válasz

Név Típus Leírás
content Byte [ ] A pdf állomány, Base64 kódolva.
status ResponseStatus_V1 A válasz státusza.
params Param_V1 [ ] Egyéb paraméterek listája.

Minta

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sign="http://sign.api.hammy.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <sign:sign>
            <request>
                <clientHashKey>221d316146c591897239</clientHashKey>
                <content>[content]</content>
                <keyAlias>hammy_test</keyAlias>
                <location>Budapest</location>
                <timestampMode>INTERNAL</timestampMode>
                <certificationLevelNoChangesAllowed>true</certificationLevelNoChangesAllowed>
                <countryCode>HU</countryCode>
            </request>
        </sign:sign>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Header/>
    <S:Body xmlns:ns2="http://sign.api.hammy.dbx.hu/">
        <ns2:signResponse>
            <response>
                <content>[signed content]</content>
                <status>
                    <code>0</code>
                    <messages/>
                </status>
            </response>
        </ns2:signResponse>
    </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/sign/v1/sign

Név Típus Leírás
requestMeta JRequestMeta_V1 A kérés metaadatai.
id Integer A kérés azonosítója. (vnd.api ID)
content Byte [ ] A pdf állomány, Base64 kódolva.
pdfSigner String Az aláírást végző bean (osztály példány) neve. Default: corePdfSigner.
keyAlias String Az aláíró kulcstárban az aláíró kulcs alias neve.
location String Az aláírás helye. Default: Budapest.
reason String Az aláírás célja.
timestampMode TimestampMode Az időbélyegzés módja.
signImage SignImage_V1 Aláírási kép objektum
certificationLevelNoChangesAllowed Boolean Az aláírás szintje, további változtatás engedélyezett-e.
visibleSignatureEnabled Boolean Látható aláírásjelzés engedélyezett-e.
visibleSignatureVerification Boolean Látható aláírásérvényesség engedélyezett-e.
visibleSimpleImageEnabled Boolean Aláírási kép látható-e.
countryCode String Ország kódja.

Válasz

Név Típus Leírás
meta JMeta1 Metaadatok.
id String A válasz azonosítója. (vnd.api ID)
content Byte [ ] A pdf állomány, Base64 kódolva.

Minta