Public API V1

HammyPublicAPI WSDL letöltése

Web service API

Ez a szolgáltatás jelenleg csak Web service-n keresztül elérhető.

Open

Üzenet megnyitása.

Web service API

Kérés

Név	Típus	Leírás
hourOfDay	Integer	Az aktuális óra.
ipAddress	String	IP cím.
mailHash	String	A levél egyedi azonosítója.
agentName	String	Agent neve.
deviceClass	String	Eszköz típusa.
osName	String	Operációs rendszer neve.
userAgentHeader	String	User agent fejléc.

Válasz

Név	Típus	Leírás
responseStatus	ResponseStatus_V1	A válasz státusza.

Minta

Kérés

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:publ="http://publ.api.hammy.dbx.hu">
   <soapenv:Header/>
   <soapenv:Body>
      <publ:open>
         <openRequest>
            <hourOfDay>?</hourOfDay>
            <ipAddress>?</ipAddress>
            <mailHash>?</mailHash>
         </openRequest>
      </publ:open>
   </soapenv:Body>
</soapenv:Envelope>

Click

Kattintás levélben lévő linkre.

Web service API

Kérés

Név	Típus	Leírás
hourOfDay	Integer	Az adott óra
ipAddress	String	IP cím.
linkBase64	String	Egy levélben szereplő link Base64 kódolt változata.
mailHash	String	Üzenet azonosítója.
agentName	String	Agent neve.
deviceClass	String	Eszköz típusa.
osName	String	Operációs rendszer neve.
mailLinkUuid	String	Üzenet link UUID-ja.
userAgentHeader	String	User agent fejléc.

Válasz

Név	Típus	Leírás
decodedLink	String	Dekódolt Base64 link.
responseStatus	ResponseStatus_V1	A válasz státusza.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:publ="http://publ.api.hammy.dbx.hu">
   <soapenv:Header/>
   <soapenv:Body>
      <publ:click>
         <clickRequest>
            <hourOfDay>?</hourOfDay>
            <ipAddress>?</ipAddress>
            <linkBase64>?</linkBase64>
            <mailHash>?</mailHash>
         </clickRequest>
      </publ:click>
   </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:Fault xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3="http://www.w3.org/2003/05/soap-envelope">
         <faultcode>ns2:Server</faultcode>
         <faultstring>null</faultstring>
      </ns2:Fault>
   </S:Body>
</S:Envelope>

Subscribe to newsletters

Feliratkozás hírlevélre.

Web service API

Kérés

Név	Típus	Leírás
emailAddress	String	Email cím.
recipientGroupIds	Integer [ ]	Ügyfelek címlistája (adatbázisbeli azonosítók).

Válasz

Név	Típus	Leírás
responseStatus	ResponseStatus_V1	A válasz státusza.

Minta

Kérés

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:publ="http://publ.api.hammy.dbx.hu">
   <soapenv:Header/>
   <soapenv:Body>
      <publ:subscribeToNewsletters>
         <subscribeRequest>
            <emailAddress>?</emailAddress>
            <recipientGroupIds>?</recipientGroupIds>
         </subscribeRequest>
      </publ:subscribeToNewsletters>
   </soapenv:Body>
</soapenv:Envelope>

Get newsletters

Hírlevelek lekérése.

Web service API

Kérés

Név	Típus	Leírás
mailHash	String	Üzenet egyedi azonosítója.

Válasz

Név	Típus	Leírás
responseStatus	ResponseStatus_V1	A válasz státusza.
subscriptions	WSubscription1 [ ]	Feliratkozások.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:publ="http://publ.api.hammy.dbx.hu">
   <soapenv:Header/>
   <soapenv:Body>
      <publ:getNewsletters>
         <getNewslettersRequest>
            <mailHash>?</mailHash>
         </getNewslettersRequest>
      </publ:getNewsletters>
   </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:getNewslettersResponse xmlns:ns2="http://publ.api.hammy.dbx.hu">
         <return>
            <responseStatus>
               <code>0</code>
               <messages>
                  <message>
                     <severity>INFO</severity>
                     <code>1</code>
                     <description>Sikeresen lefutott</description>
                  </message>
               </messages>
            </responseStatus>
         </return>
      </ns2:getNewslettersResponse>
   </S:Body>
</S:Envelope>

Global unsubscribe

Globális leiratkozás hírlevélről.

Web service API

Kérés

Név	Típus	Leírás
mailHash	String	Az üzenet egyedi azonosítója.
reasonCode	String	A leiratkozás okának kódja.
reasonDescription	String	A leiratkozás okának leírása.
ipAddress	String	IP cím.
deviceClass	String	Eszköz típusa.
osName	String	Operációs rendszer neve.
agentName	String	Agent neve.
userAgentHeader	String	User agent fejléc.
httpMethod	String	A kívülről érkező unsubscribe hívás a hammyPublic-ba POST vagy GET metódussal érkezett-e.

Válasz

Név	Típus	Leírás
globalUnsubscribeNotAllowed	Boolean	A globális leiratkozás nem megengedett.
responseStatus	ResponseStatus_V1	A válasz státusza.
subscriptions	WSubscription1 [ ]	Feliratkozások.

Minta

Kérés

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:publ="http://publ.api.hammy.dbx.hu">
   <soapenv:Header/>
   <soapenv:Body>
      <publ:globalUnsubscribe>
         <globalUnsubscribeRequest>
            <mailHash>?</mailHash>
         </globalUnsubscribeRequest>
      </publ:globalUnsubscribe>
   </soapenv:Body>
</soapenv:Envelope>

Edit newsletter subscriptions

Hírlevél feliratkozások módosítása.

Web service API

Kérés

Név	Típus	Leírás
mailHash	String	Üzenet azonosítója.
subscriptions	Integer [ ]	Címlista azonosítók listája.

Válasz

Név	Típus	Leírás
responseStatus	ResponseStatus_V1	A válasz státusza.

Minta

Kérés

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:publ="http://publ.api.hammy.dbx.hu">
   <soapenv:Header/>
   <soapenv:Body>
      <publ:editNewsletterSubscriptions>
         <editNewsletterSubscriptionsRequest>
            <mailHash>?</mailHash>
            <subscriptions>?</subscriptions>
         </editNewsletterSubscriptionsRequest>
      </publ:editNewsletterSubscriptions>
   </soapenv:Body>
</soapenv:Envelope>

Send token

Token küldése.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
emailAddress	String	Partner email címe.
messageUuid	String	Üzenet UUID.
ipAddress	String	IP cím.

Válasz

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

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:publ="http://publ.api.hammy.dbx.hu">
   <soapenv:Header/>
   <soapenv:Body>
      <publ:sendToken>
         <sendTokenRequest>
            <requestMeta>
               <clientHashKey>{clientHashKey}</clientHashKey>
               <userName>admin</userName>
            </requestMeta>
            <emailAddress>teszt@dbx.hu</emailAddress>
            <messageUuid>845fb03f-b19f-4e21-8bf2-bd2832b4eb6a</messageUuid>
         </sendTokenRequest>
      </publ:sendToken>
   </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:sendTokenResponse xmlns:ns2="http://publ.api.hammy.dbx.hu" xmlns:ns3="http://hammy.dbx.hu/model/publ/v1">
         <return>
            <responseStatus>
               <code>0</code>
               <messages/>
            </responseStatus>
            <params/>
            <tokenInfo>
               <address>+36301111111</address>
               <channel>SMS</channel>
               <expirationTime>2025-02-10T11:36:42.378+01:00</expirationTime>
               <factor>TWO</factor>
            </tokenInfo>
         </return>
      </ns2:sendTokenResponse>
   </S:Body>
</S:Envelope>

Authenticate partner

Partnerek autentikációja.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
emailAddress	String	Partner email címe.
password	String	Partner jelszava.
messageUuid	String	Az üzenet UUID-ja.

Válasz

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

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:publ="http://publ.api.hammy.dbx.hu">
   <soapenv:Header/>
   <soapenv:Body>
      <publ:authenticatePartner>
         <authenticatePartnerRequest>
            <requestMeta>
               <clientHashKey>{clientHashKey}</clientHashKey>
               <userName>admin</userName>
            </requestMeta>
            <emailAddress>teszt@dbx.hu</emailAddress>
            <password>TesztJelszo123</password>
            <messageUuid>7e43d02e-03ef-4cc5-846d-850e06ccaa20</messageUuid>
         </authenticatePartnerRequest>
      </publ:authenticatePartner>
   </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:authenticatePartnerResponse xmlns:ns2="http://publ.api.hammy.dbx.hu" xmlns:ns3="http://hammy.dbx.hu/model/publ/v1">
         <return>
            <responseStatus>
               <code>0</code>
               <messages/>
            </responseStatus>
            <params/>
         </return>
      </ns2:authenticatePartnerResponse>
   </S:Body>
</S:Envelope>

Activate partner session

Partner session aktiválása.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
emailAddress	String	Partner email címe.
ipAddress	String	IP cím.
messageUuid	String	Üzenet UUID.

Válasz

Név	Típus	Leírás
responseStatus	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
partnerStatus	String	A partner státusza.
tokenInfo	WTokenInfo1	A token adatai.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:publ="http://publ.api.hammy.dbx.hu">
   <soapenv:Header/>
   <soapenv:Body>
      <publ:activatePartnerSession>
         <activatePartnerSessionRequest>
            <requestMeta>
               <clientHashKey>{clientHashKey}</clientHashKey>
               <userName>admin</userName>
            </requestMeta>
            <emailAddress>teszt@dbx.hu</emailAddress>
            <ipAddress>195.162.111.111</ipAddress>
            <messageUuid>7e43d02e-03ef-4cc5-846d-850e06ccaa20</messageUuid>
         </activatePartnerSessionRequest>
      </publ:activatePartnerSession>
   </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:activatePartnerSessionResponse xmlns:ns2="http://publ.api.hammy.dbx.hu" xmlns:ns3="http://hammy.dbx.hu/model/publ/v1">
         <return>
            <responseStatus>
               <code>0</code>
               <messages/>
            </responseStatus>
            <params/>
            <partnerStatus>REGISTERED</partnerStatus>
         </return>
      </ns2:activatePartnerSessionResponse>
   </S:Body>
</S:Envelope>

Create encryption key

Titkosítási kulcs létrehozása.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
emailAddress	String	Partner email címe.
nonce	String	Nonce.
ipAddress	String	IP cím.
messageUuid	String	Üzenet UUID.

Válasz

Név	Típus	Leírás
responseStatus	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
encryptionKey	Byte [ ]	Titkosítási kulcs, Base64 kódolva.

Minta

Register partner

Partner regisztráció.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
emailAddress	String	Partner email címe.
token	String	Partner tokenje.
password	String	Partner jelszava.
ipAddress	String	IP cím.
messageUuid	String	Üzenet UUID.

Válasz

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

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:publ="http://publ.api.hammy.dbx.hu">
   <soapenv:Header/>
   <soapenv:Body>
      <publ:registerPartner>
         <registerPartnerRequest>
            <requestMeta>
               <clientHashKey>{clientHashKey}</clientHashKey>
               <userName>admin</userName>
            </requestMeta>
            <emailAddress>teszt@dbx.hu</emailAddress>
            <token>23448524</token>
            <password>Teszt1234</password>
            <ipAddress>195.162.111.111</ipAddress>
            <messageUuid>7e43d02e-03ef-4cc5-846d-850e06ccaa20</messageUuid>
         </registerPartnerRequest>
      </publ:registerPartner>
   </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:registerPartnerResponse xmlns:ns2="http://publ.api.hammy.dbx.hu" xmlns:ns3="http://hammy.dbx.hu/model/publ/v1">
         <return>
            <responseStatus>
               <code>0</code>
               <messages/>
            </responseStatus>
            <params/>
         </return>
      </ns2:registerPartnerResponse>
   </S:Body>
</S:Envelope>

Create partner event

Partner esemény létrehozása.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
emailAddress	String	Partner email címe.
eventName	String	Esemény neve.
eventParams	String	Esemény paraméterek.
ipAddress	String	IP cím.
messageUuid	String	Kapcsolódó Hammy üzenet UUID-ja.
attachmentUuid	String	Kapcsolódó Hammy melléklet UUID-ja.

Válasz

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

Minta

Get encrypted mail

Titkosított levél lekérése.

Web service API

Kérés

Név	Típus	Leírás
requestMeta	RequestMeta_V1	A kérés metaadatai.
messageUuid	String	Az üzenet UUID-ja.
ipAddress	String	IP cím.

Válasz

Név	Típus	Leírás
responseStatus	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.
content	Byte [ ]	Az üzenet tartalma.

Minta