PodporaAPI dokumentace

mailkit.email.wipe

Funkcí mailkit.email.wipe je možné zcela anonymizovat a odstranit data příjemce, jež vznesl požadavek na zapomenutí. Po zpracování dojde k odstranění veškerých dat příjemce a pro účely zachování komplexnosti reportů bude e-mailová adresa nahrazena za anonymizovaný hash.

Požadavky na anonymizaci jsou ukládány do fronty a fronta je zpracovávána jednou denně.

Ukázka API volání:

XML

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.email.wipe</methodName>
  <params>
    <param>
    <value>
      <int>client_id</int>
    </value>
    </param>
    <param>
    <value>
      <string>client_md5</string>
    </value>
    </param>
    <param>
    <value>
      <string>ID_email</string>
    </value>
    </param>
  </params>
</methodCall>

JSON

{
  "function": "mailkit.email.wipe",
  "id": "client_id",
  "md5": "client_md5",
  "parameters": {
	"email": "example@example.com", nebo
	"ID_email":"12345678"
  }
}

Hodnoty:

client_id * = API ID naleznete ve svém Mailkit účtu v menu Profil / Integrace / Nastavení API.
client_md5 * = MD5 kód naleznete ve svém Mailkit účtu v menu Profil / Integrace / Nastavení API.
ID_email * = Pro XML volání může obsahovat buď konkrétní ID e-mailu (vrací např. funkce mailkit.mailinglist.adduser), nebo e-mailovou adresu.
email = emailová adresa

* povinný parametr

Po úspěšném volání se vrací

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
    <params>
        <param>
            <value>
                <struct>
                    <member>
                        <name>email</name>
                        <value>
                            <string>example@example.com</string>
                        </value>
                    </member>
                    <member>
                        <name>error_status</name>
                        <value>
                            <i4>0</i4>
                        </value>
                    </member>
                    <member>
                        <name>ID_email</name>
                        <value>
                            <i4>12345678</i4>
                        </value>
                    </member>
                    <member>
                        <name>error</name>
                        <value>
                            <string>OK</string>
                        </value>
                    </member>
                </struct>
            </value>
        </param>
    </params>
</methodResponse>

JSON

{
	"ID_email": 12345678,
	"email": "example@example.eu",
	"error_status": 0,
	"error": "OK"
}

Hodnoty:

ID_email = ID e-mailové adresy
email = e-mailová adresa
error = OK - bez chyby
error_status = 0 - bez chyby

Příklad neúspěšného volání:

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
    <params>
        <param>
            <value>
                <string>Email has already been inserted</string>
            </value>
        </param>
    </params>
</methodResponse>

JSON

{
	"error_status": 1,
	"error": "Invalid ID_email or email"
}

Hodnoty:

Missing ID_email = chybějící ID e-mailové adresy
Invalid_ID_email or email = neplatné ID e-mailové adresy nebo e-mailová adresa
Email has already been inserted = tato e-mailová adresa již byla vložena do fronty ke zpracování