Generate API V1
HammyGenerateAPI WSDL letöltése
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 | WGenerationItem_V1 [ ] | 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
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:gen="http://generate.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<gen:generate>
<request>
<documentTarget>FS</documentTarget>
<items>
<documentTarget>FS</documentTarget>
<fileName>item2.pdf</fileName>
<mimeType>application/pdf</mimeType>
<properties>{
"kulcs3" : 6,
"actualDate" : "dét",
"address" : {
"streetAddress" : "etele ut 8.",
"city" : "Budapest",
"name" : "fogam akos"
}}
</properties>
<status>GENERATED</status>
<templateType>TT1</templateType>
<versionNumber>1</versionNumber>
</items>
<mimeType>application/pdf</mimeType>
<params> {
"kulcs1" : "l1",
"kulcs2" : 5,
"address.name" : "teszt elek"
}
</params>
<!--<status>REQUESTED</status>-->
<templateType>TT_X</templateType>
<versionNumber>2</versionNumber>
<requestMeta>
<clientHashKey>dfdsf</clientHashKey>
<userName>?</userName>
<params>
<param>
<key>?</key>
<value>?</value>
<ref>?</ref>
</param>
</params>
</requestMeta>
</request>
</gen:generate>
</soapenv:Body>
</soapenv:Envelope><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:generateResponse xmlns:ns2="http://generate.api.hammy.dbx.hu/">
<response>
<generationRequest>
<documentTarget>FS</documentTarget>
<items>
<documentTarget>FS</documentTarget>
<fileName>item2.pdf</fileName>
<mimeType>application/pdf</mimeType>
<status>GENERATED</status>
<templateType>TT1</templateType>
<uuid>9f88bc28-9466-41bb-8bfa-1fda1e9693d5</uuid>
<versionNumber>1</versionNumber>
</items>
<mimeType>application/pdf</mimeType>
<status>GENERATED</status>
<templateType>TT_X</templateType>
<uuid>d7adb60f-0915-4c51-9932-73af702f56c8</uuid>
<versionNumber>2</versionNumber>
</generationRequest>
<status>
<code>0</code>
<messages/>
</status>
</response>
</ns2:generateResponse>
</S:Body>
</S:Envelope>REST API
Kérés
POST hammy/json/generate/v1/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 | JGenerationItem1 [ ] | 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
POST /hammy/json/generate/v1/generate?clientHashKey={{clientHashKey}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+json
{
"data" : {
"type" : "generationRequests",
"id" : "65357088-a31c-4caf-b3d6-d0deb24e9716",
"attributes" : {
"mimeType" : "application/pdf",
"templateType" : "TT1",
"versionNumber" : 1,
"documentTarget" : "FS",
"properties" : {
"kulcs1" : "l1",
"kulcs2" : 5,
"address.name" : "teszt elek"
}
},
"relationships" : {
"items" : {
"data" : [ {
"type" : "generationItems",
"id" : "e4900eaf-7105-4088-8cf3-2ea88ff3919c"
} ]
}
}
},
"included" : [ {
"type" : "generationItems",
"id" : "e4900eaf-7105-4088-8cf3-2ea88ff3919c",
"attributes" : {
"mimeType" : "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"templateType" : "TT1",
"versionNumber" : 1,
"documentTarget" : "FS",
"fileName" : "item2.docx",
"status" : "GENERATING",
"properties" : {
"kulcs3" : 6,
"address.name" : "fogam akos",
"actualDate" : "dét",
"address" : {
"streetAddress" : "etele ut 8.",
"city" : "Budapest",
"name" : "fogam akos"
}
}
}
} ]
}HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"type": "generationRequests",
"id": "65357088-a31c-4caf-b3d6-d0deb24e9716",
"attributes": {
"mimeType": "application/pdf",
"templateType": "TT1",
"versionNumber": 1,
"documentTarget": "FS",
"status": "GENERATED",
"properties": {
"kulcs1": "l1",
"kulcs2": 5,
"address.name": "teszt elek"
}
},
"relationships": {
"items": {
"data": [
{
"type": "generationItems",
"id": "e4900eaf-7105-4088-8cf3-2ea88ff3919c"
}
]
}
}
},
"included": [
{
"type": "generationItems",
"id": "e4900eaf-7105-4088-8cf3-2ea88ff3919c",
"attributes": {
"mimeType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"templateType": "TT1",
"versionNumber": 1,
"documentTarget": "FS",
"fileName": "item2.docx",
"status": "GENERATED",
"properties": {
"kulcs3": 6,
"address.name": "fogam akos",
"actualDate": "dét",
"address": {
"streetAddress": "etele ut 8.",
"city": "Budapest",
"name": "fogam akos"
}
}
}
}
],
"meta": {
"total": null,
"params": [],
"responseStatus": {
"code": 0,
"messages": []
}
}
}Download
Dokumentumok letöltésére szolgáló kérés küldése. Lehetőség van a sablonokból legenerált PDF-ek letöltésére és az eredeti sablon is letölthető.
Web service API
Kérés
| Név | Típus | Leírás |
|---|---|---|
| requestMeta | RequestMeta_V1 | A kérés metaadatai. |
| uuid | String | A letöltendő sablon UUID-ja (WGenerationItem_V1). |
| originalRequested | String | true/false Megadja, hogy a sablon docx-et szeretnénk letölteni (eredeti) vagy a generált PDF-et. |
| fragmentName | String | Egy sablon több alsablonból is felépülhet. Ilyenkor ezzel adja meg, hogy az eredeti docx melyik alsablonja töltődjön le. |
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
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:gen="http://generate.api.hammy.dbx.hu/">
<soapenv:Header/>
<soapenv:Body>
<gen:download>
<!--Optional:-->
<request>
<!--Optional:-->
<requestMeta>
<!--Optional:-->
<clientHashKey>?</clientHashKey>
<!--Optional:-->
<userName>?</userName>
<!--Optional:-->
<params>
<!--Zero or more repetitions:-->
<param>
<key>?</key>
<value>?</value>
<!--Optional:-->
<ref>?</ref>
</param>
</params>
</requestMeta>
<fragmentName>pdfnélSemmitNemCsinál</fragmentName>
<originalRequested>false</originalRequested>
<uuid>9f88bc28-9466-41bb-8bfa-1fda1e9693d5</uuid>
</request>
</gen:download>
</soapenv:Body>
</soapenv:Envelope><S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:downloadResponse xmlns:ns2="http://generate.api.hammy.dbx.hu/">
<response>
<generatedDocument>
<content>[BASS64 content]</content>
<fileName>item2.pdf</fileName>
<mimeType>application/pdf</mimeType>
</generatedDocument>
<status>
<code>0</code>
<messages/>
</status>
</response>
</ns2:downloadResponse>
</S:Body>
</S:Envelope>REST API
Kérés
GET hammy/json/generate/v1/download/{{uuid}}
path
| Név | Típus | Leírás |
|---|---|---|
| uuid | String | A letöltendő sablon UUID-ja. |
| Paraméter | Típus | Leírás |
|---|---|---|
| uuid | String | A letöltendő sablon UUID-ja (WGenerationItem_V1). |
| originalRequested | String | true/false Megadja, hogy a sablon docx-et szeretnénk letölteni (eredeti) vagy a generált PDF-et. |
| fragmentName | String | Egy sablon több alsablonból is felépülhet. Ilyenkor ezzel adja meg, hogy az eredeti docx melyik alsablonja töltődjön le. |
Válasz
application/octet-stream
A kért dokumentum tartalma binárisan.
Minta
GET /hammy/json/generate/v1/download/{{generationItems.id}}?originalRequested={{N}}&fragmentName={{relationName}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}
Content-Type: application/vnd.api+jsonHTTP/1.1 200 OK
Authorization: JWT {{jwtToken}}
Content-Type: {{generationItems.mimeType}}
Content-Disposition: attachment; filename*=UTF-8''{{generationItems.fileName}}
Transfer-Encoding: chunked
[BINÁRIS TARTALOM]Generate proof of dispatch
Levélküldési igazolás generálása.
Web service
Ebben a verzióban ez a funkció csak Web service-n érhető el.
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
Generate proofs of dispatches
Tömeges levélküldési igazolások generálása.
Web service
Ebben a verzióban ez a funkció csak Web service-n érhető el.
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
Utoljára frissítve
