Generate API V2

Generate

Dokumentum generálási kérés küldése a Hammy-be. Egyszerre több dokumentum generálása is kérhető. A generálás paraméterei kérés és tétel szinten is megadhatóak. A tétel szintűnek van magasabb prioritása.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
uuid	String	Dokumentum generálási kérés UUID.
mimeType	String	A generálandó file mime típusa.
templateType	String	A generálásra használandó sablon kódja. A `messageType` fogalommal azonos, csak itt pontosabb megnevezéssel bír.
versionNumber	Integer	A generálásra használandó sablon verziója
documentTarget	String	A generált fájl tárolási helye.
status	String	A generálási folyamat cél állapota.
properties	String	A generáláshoz használt paraméterek. JSON adatstruktúra.
items	WGenerationItem2 [ ]	A generálandó fájlok tételenként.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.

A válasz tartalmazza az eredeti kérés mezőit is.

Minta

REST API

REST API Info

Kérés

POST hammy/json/generate/v2/generate

Név	Típus	Leírás
uuid	String	Dokumentum generálási kérés UUID. (vnd.api ID)
mimeType	String	A generálandó file mime típusa.
templateType	String	A generálásra használandó sablon kódja. A `messageType` fogalommal azonos, csak itt pontosabb megnevezéssel bír.
versionNumber	Integer	A generálásra használandó sablon verziója
documentTarget	String	A generált fájl tárolási helye.
status	String	A generálási folyamat cél állapota.
properties	Kulcs-érték párok	A generáláshoz használt paraméterek.
items	JGenerationItem2 [ ]	A generálandó fájlok tételenként.

Válasz

Név	Típus	Leírás
meta	JMeta1	Metaadatok.

A válasz tartalmazza az eredeti kérés mezőit is.

Minta

KérésVálasz

POST /hammy/json/generate/v2/generate
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

{
  "mimeType": "application/pdf",
  "templateType":"Kostolo_Elmenykartya_PDF",
  "documentTarget":"DMS"
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "type": "generationRequests",
    "id": "f5a10085-aed8-41ee-b031-0c1923d0d038",
    "attributes": {
      "mimeType": "application/pdf",
      "templateType": "Kostolo_Elmenykartya_PDF",
      "documentTarget": "DMS",
      "status": "REQUESTED",
      "properties": {
        "lablectelefonszam": "+36 30 123 45 67",
        "level_varos": "Budapest",
        "velocity_param": "Ha ez jelenik meg, az jo. ",
        "actualDate": "2024.05.13",
        "residence_address": "1148 Budapest, Teszt. u. 47.",
        "ecm_fulk_ceg_neve": "Teszt - Teszt Zrt."
      }
    },
    "relationships": {
      "items": {
        "data": []
      }
    }
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Generate simple

Egyszerűsített dokumentum generálási kérés küldése a Hammy-be. Egyszerre egy dokumentum generálása kérhető. Ha a download paraméter értéke igaz akkor a válaszban rögtön visszadja a fájlt, egyébként a generált dokumentum uuid-val tér vissza.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
uuid	String	Dokumentum generálási kérés UUID.
mimeType	String	A generálandó file mime típusa.
templateType	String	A generálásra használandó sablon kódja. A `messageType` fogalommal azonos, csak itt pontosabb megnevezéssel bír.
versionNumber	Integer	A generálásra használandó sablon verziója
documentTarget	String	A generált fájl tárolási helye.
status	String	A generálási folyamat cél állapota.
properties	String	A generáláshoz használt paraméterek. JSON adatstruktúra.
generationItemUuid	String	Generálandó dokumentum UUID. (vnd.api ID)
fileName	String	A generált fájl felhasználó felé mutatott neve.
signExpected	Boolean	Aláírandó-e?
download	Boolean	A generált fájlt visszaadja-e a válaszban?

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
generatedDocument	WGeneratedDocument_V1	A kért dokumentum.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v2="http://hammy.dbx.hu/api/generate/v2">
    <soapenv:Header/>
    <soapenv:Body>
        <v2:generateSimple>
            <request>
                <requestMeta>
                    <clientHashKey>{{clientHashKey}}</clientHashKey>
                    <userName>{{username}}</userName>
                </requestMeta>
                <uuid>f152df98-6543-43f2-b756-d9ef8479d008</uuid>
                <mimeType>application/pdf</mimeType>
                <templateType>pdf_sablon</templateType>
                <versionNumber>1</versionNumber>
                <documentTarget>FS</documentTarget>
                <properties>{"email_cim": "sasd"}</properties>
                <generationItemUuid>bfee03e0-95a1-44e9-a09f-bd7158ce599d</generationItemUuid>
                <fileName>teszt.docx</fileName>
                <signExpected>false</signExpected>
                <download>true</download>
            </request>
        </v2:generateSimple>
    </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>
    <ns2:generateSimpleResponse xmlns:ns2="http://hammy.dbx.hu/api/generate/v2" xmlns:ns3="http://v2.generate.api.hammy.dbx.hu/">
        <response>
            <generatedDocument>
                <content>[BASS64 content]</content>
                <fileName>teszt.docx</fileName>
                <generationItemUuid>bfee03e0-95a1-44e9-a09f-bd7158ce599d</generationItemUuid>
                <mimeType>application/pdf</mimeType>
            </generatedDocument>
            <params/>
            <status>
                <code>0</code>
                <messages/>
            </status>
        </response>
    </ns2:generateSimpleResponse>
</S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

POST hammy/json/generate/v2/generateSimple

Név	Típus	Leírás
uuid	String	Dokumentum generálási kérés UUID.
mimeType	String	A generálandó file mime típusa.
templateType	String	A generálásra használandó sablon kódja. A `messageType` fogalommal azonos, csak itt pontosabb megnevezéssel bír.
versionNumber	Integer	A generálásra használandó sablon verziója
documentTarget	String	A generált fájl tárolási helye.
status	String	A generálási folyamat cél állapota.
properties	Kulcs-érték párok	A generáláshoz használt paraméterek.
generationItemUuid	String	Generálandó dokumentum UUID.
fileName	String	A generált fájl felhasználó felé mutatott neve.
signExpected	Boolean	Aláírandó-e?
download	Boolean	A generált fájlt visszaadja-e a válaszban?

JSON API

Content-Type: application/vnd.api+json
Típus neve: generateSimpleRequests
Azonosítóval megjelölt mező: uuid

Válasz

Ha a download paraméter értéke igaz, akkor a kért dokumentum tartalma binárisan: application/octet-stream, egyéb esetben a következő:

Név	Típus	Leírás
meta	JMeta1	Metaadatok.
generationItemUuid	String	Generált dokumentum UUID.

Minta

KérésVálasz

POST hammy/json/generate/v2/generate/generateSimple
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/json

{
  "uuid": "f152df98-6543-43f2-b756-d9ef8479d008",
  "mimeType": "application/pdf",
  "templateType": "pdf_sablon",
  "versionNumber": 1,
  "fileName": "teszt.docx",
  "documentTarget": "FS",
  "download": true,
  "generationItemUuid": "bfee03e0-95a1-44e9-a09f-bd7158ce588d",
  "properties": {
    "email_cim": "teszt@teszt.hu"
  }
}

HTTP/1.1 200 OK
Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document;charset=UTF-8
Content-Disposition: attachment; filename*=UTF-8''teszt.docx
Transfer-Encoding: chunked

[BINÁRIS TARTALOM]

Download

Ebben a verzióban nem változott.

Download V1

Generate proof of dispatch

Levélküldési igazolás generálása.

Web service

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
messageUuid	String	Az üzenet UUID-ja.
messageId	Integer	Az üzenet ID-ja.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.

A válasz tartalmazza a Generate kérés mezőit is.

Minta

REST API

REST API Info

Kérés

POST hammy/json/generate/v2/generate/proofOfDispatch

Név	Típus	Leírás
messageUuid	String	Az üzenet UUID-ja.
messageId	Integer	Az üzenet ID-ja.

Válasz

Név	Típus	Leírás
meta	JMeta1	Metaadatok.

A válasz tartalmazza a Generate kérés mezőit is.

Minta

KérésVálasz

POST hammy/json/generate/v2/generate/proofOfDispatch
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json

{
  "messageUuid": "775f0b32-604d-4d8f-9d63-4cc015b747e4"
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "type": "generationRequests",
    "id": "7eafcd40-d448-467d-a8c5-50a61a4dfa3e",
    "attributes": {
      "status": "GENERATED",
      "properties": {
        "actualDate": "2024.01.23"
      }
    },
    "relationships": {
      "items": {
        "data": [
          {
            "type": "generationItems",
            "id": "1e2cc676-823f-40ee-908e-e2849643c85c"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "generationItems",
      "id": "1e2cc676-823f-40ee-908e-e2849643c85c",
      "attributes": {
        "mimeType": "application/pdf",
        "templateType": "PROOF_OF_DISPATCH_MINTA",
        "versionNumber": 6,
        "documentTarget": "DMS",
        "fileName": "proof-of-dispatch-a7f50728f2638d5497efe1d33ff124be63204b77.pdf",
        "status": "GENERATED",
        "signExpected": true,
        "properties": {
          "SMTP_MESSAGE_ID": "<410508110.5.1705949363355@hammy-tomcat.xen.dbx.lan>",
          "statusDesc": "Kiküldve",
          "attachments": [],
          "TEST_MAIL": "YES",
          "DMS_DOCUMENT_ID": "6ac4d340-20aa-4d0f-b9dd-70b3e0529ef8",
          "aggrArchiveStatus": "UNNECESSARY",
          "emailSentAt": "2024.01.22. 19:49",
          "channel": "EMAIL",
          "PROOF_OF_DISPATCH_DMS_DOCUMENT_ID": "6ac4d340-20aa-4d0f-b9dd-70b3e0529ef8",
          "emailSubject": "test",
          "PROOF_OF_DISPATCH_GENERATION_ITEM_UUID": "1e2cc676-823f-40ee-908e-e2849643c85c",
          "archExp": false,
          "createdAt": "2024.01.22. 19:49",
          "PROOF_OF_DISPATCH_DMS_DOCUMENT_VERSION_ID": "ca700975-8422-47e8-948c-f77490d8aac9",
          "messageUuid": "775f0b32-604d-4d8f-9d63-4cc015b747e4",
          "messageType": "GROUPSABLON1",
          "DMS_DOCUMENT_VERSION_ID": "ca700975-8422-47e8-948c-f77490d8aac9",
          "fromName": "Hammy 8.50 Tomcat (DBX Groupama GDPR)",
          "recipientEmailAddress": "teszt.bela@dbx.hu",
          "recipientName": "Béla",
          "messageHash": "a7f50728f2638d5497efe1d33ff124be63204b77",
          "fromEmailAddress": "noreply@dbx.hu",
          "status": "SENT"
        }
      }
    }
  ],
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}

Generate proofs of dispatches

Tömeges levélküldési igazolások generálása.

Web service

Kérés

Név	Típus	Leírás	Kötelező
uuid	String	A levél UUID-ja.
clientHashKey	String	A hívó kliens azonosítója.	*
messageTypes	String [ ]	Az üzenet típusok.
recipientName	String	A címzett neve.
recipientAddress	String	A címzett email címe.
partnerRef	String	Partner azonosító.
objectRef	String	A kapcsolódó objektum azonosítója (pl. szerződésszám).
objectType	String	A kapcsolódó objektum típusa (pl. számla).
batchId	String	Köteg azonosító.
createdAtFrom	DateTime	A keresési időintervallum kezdete.
createdAtTo	DateTime	A keresési időintervallum vége.
bouncedAtFrom	DateTime	A visszapattanási időpont keresési időintervallum kezdete.
bouncedAtTo	DateTime	A visszapattanási időpont keresési időintervallum vége.
fileName	String	A csatolmány neve.
internalFileName	String	A csatolmány belső rendszerben használt neve.
resultSize	Integer	A keresési találat maximális mérete Alapértelmezett értéke 20.
offset	Integer	A találati lista kezdete.
deliveryStatuses	String [ ]	Az üzenet kézbesítési státusza.
archiveStatuses	ArchiveStatus [ ]	Az archiválási státusza.
extendedStatueses	String [ ]	Kiterjesztett státusz, csatorna specifikus állapotokról hordoz információt.
messageChannels	MessageChannel [ ]	Az üzenet küldési csatornája.
properties	Property1 [ ]	Az üzenethez tartozó egyéb adatok, metaadatok.
params	Param_V1 [ ]	Egyéb metaadatok listája.
userName	String	Felhasználó név.
requestId	String	Külső üzenet küldési kérés azonosító.
itemId	String	Üzenethez kapcsolódó item id.
hash	String	Üzenethez kapcsolódó hash.
opened	Boolean	Megnyitotta-e a címzett az üzenetet.
locked	Boolean	Zárolt-e az üzenet.
showDeletedMessages	Boolean	Törölt üzenetek mutatása.
mailLinkTitle	String	Üzenetben található link címe.
directions	MessageDirection [ ]	Üzenet iránya (bejövő/kimenő).
subject	String	Üzenet tárgya.
orders	Order_V1 [ ]	Rendezések.

Válasz

Név	Típus	Leírás
jobUuid	String	A létrejött job UUID-ja.
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.

Minta

REST API

REST API Info

Kérés

POST hammy/json/generate/v2/generate/proofsOfDispatches

body

Paraméter/Név	Típus	Leírás
id	String	A kérés azonosítója. (vnd.api ID)
uuid	String	Az üzenet UUID-ja.
recipientName	String	A címzett neve.
recipientAddress	String	A címzett email címe.
recipientPhoneNumber	String	A címzett telefonszáma.
partnerRef	String	Partner azonosító.
objectRef	String	A kapcsolódó objektum azonosítója (pl. szerződésszám).
objectType	String	A kapcsolódó objektum típusa (pl. számla).
createdAtFrom	DateTime	A készítési dátum intervallum alja.
createdAtTo	DateTime	A készítési dátum intervallum teteje.
bouncedAtFrom	DateTime	A visszapattanási dátum intervallum alja.
bouncedAtTo	DateTime	A visszapattanási dátum intervallum teteje.
statusLastChangedAtFrom	DateTime	Az utolsó státuszváltozás dátum intervallum alja.
statusLastChangedAtTo	DateTime	Az utolsó státuszváltozás dátum intervallum teteje.
fileName	String	A csatolmány neve.
internalFileName	String	A csatolmány belső rendszerben használt neve.
requestId	String	A kérés azonosítója.
hash	String	Az üzenet hash-e.
itemId	Integer	A lekérdezendő üzenethez kapcsolódó Chaingun Item ID-ja.
opened	Boolean	Megnyitották-e az üzenetet.
locked	Boolean	Zárolt-e az üzenet.
showDeletedMessages	Boolean	A törölt üzenetek megjelenjenek-e a találatokban.
mailLinkTitle	String	Az üzenetben lévő link címe.
subject	String	Az üzenet tárgya.
messageTypes	String [ ]	Az üzenet típusok.
deliveryStatuses	String [ ]	Az üzenet kézbesítési státuszai.
archiveStatuses	ArchiveStatus [ ]	Az üzenet archiválási státuszai.
extendedStatuses	String [ ]	Kiterjesztett státuszok, csatorna specifikus állapotokról hordoznak információt.
channels	String [ ]	Az keresett üzenetek csatornái.
directions	MessageDirection [ ]	Küldés irányai.
properties	JProperty1 [ ]	Az üzenethez tartozó egyéb adatok, metaadatok.
limit	Integer	A keresési találatok maximális száma.
offset	Integer	A találati lista kezdete (pl. resultSize = 10 és offset = 1, akkor a teljes találati lista 11. elemétől a 20. eleméig tartó listát adja vissza).
sort	String	Rendezés.
clientHashKey	String	A hívó kliens azonosítója.
userName	String	A felhasználó neve.
params	Param_V1 [ ]	Egyéb meta adatok.

Válasz

Név	Típus	Leírás
meta	JMeta1	Metaadatok.
id	String	Kérés azonosító. (vnd.api ID)
jobUuid	String	A létrejött job UUID-ja.

Minta

KérésVálasz

POST /hammy/json/generate/v2/generate/proofsOfDispatches
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

{
  "recipientAddress": "teszt@dbx.hu",
  "recipientName":"Teszt név",
  "createdAtFrom":"2024-05-10",
  "createdAtTo":"2024-05-14",
  "fileName":"teszt.pdf",
  "internalFileName":"teszt.pdf"
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "type": "generateProofsOfDispatchesResponses",
    "id": "a377949c-e32c-4efa-a5a9-9172b3e0e1c2",
    "attributes": {
      "jobUuid": "d3922094-3548-46c3-899f-683466d7634b"
    }
  },
  "meta": {
    "params": [],
    "responseStatus": {
      "code": 0,
      "messages": []
    }
  }
}