Zmail REST API

Pro správu e-mailové služby Zmail poskytujeme REST API, které umožňuje automatizovat administraci e-mailových schránek a jejich nastavení přímo z vašich vlastních systémů nebo aplikací.

Pomocí tohoto API můžete například:

• automaticky vytvářet nové e-mailové schránky
• upravovat jejich parametry
• získávat informace o existujících schránkách
• odstraňovat schránky, pokud již nejsou potřeba

API je vhodné pro integraci do zákaznických portálů, hostingových administrací, firemních systémů nebo jiných automatizačních nástrojů.

Princip komunikace

API je založeno na REST a komunikuje pomocí protokolu HTTPS. Všechna data jsou přenášena ve formátu JSON. Jednotlivé operace využívají standardní HTTP metody:

• GET – získání informací
• POST – vytvoření nové položky
• PUT – úprava existující položky
• DELETE – odstranění položky

Seznam hlavních operací

1. Získání seznamu schránek

Vrátí seznam všech e-mailových schránek na zadané doméně.

GET /api/Zmail/{domainName}/mailboxes

Ukázkový požadavek:

GET https://api.czechia.com/api/Zmail/firma.cz/mailboxes

Ukázková odpověď:

[
  {"mailboxName":"info","email":"info@firma.cz","quota":2048},
  {"mailboxName":"obchod","email":"obchod@firma.cz","quota":4096}
]

2. Získání detailu schránky

Vrátí detailní informace o konkrétní schránce.

GET /api/Zmail/{domainName}/mailboxes/{mailboxName}

Ukázkový požadavek:

GET https://api.czechia.com/api/Zmail/firma.cz/mailboxes/info

Ukázková odpověď:

{
  "mailboxName": "info",
  "email": "info@firma.cz",
  "quota": 2048,
  "usedSpace": 350
}

3. Vytvoření nové schránky

Vytvoří novou e-mailovou schránku.

POST /api/Zmail/{domainName}/mailboxes

Ukázkový požadavek:

POST https://api.czechia.com/api/Zmail/firma.cz/mailboxes
Content-Type: application/json

Body požadavku:

{
  "mailboxName": "podpora",
  "password": "silneheslo123",
  "quota": 2048
}

Ukázková odpověď:

{"message": "Mailbox byl úspěšně vytvořen"}

4. Úprava schránky

Umožňuje změnit nastavení existující schránky (např. kvóta nebo heslo).

PUT /api/Zmail/{domainName}/mailboxes/{mailboxName}

Ukázkový požadavek:

PUT https://api.czechia.com/api/Zmail/firma.cz/mailboxes/info
Content-Type: application/json

Body požadavku:

{
  "quota": 4096
}

Ukázková odpověď:

{"message": "Nastavení schránky bylo aktualizováno"}

5. Smazání schránky

Odstraní existující e-mailovou schránku.

DELETE /api/Zmail/{domainName}/mailboxes/{mailboxName}

Ukázkový požadavek:

DELETE https://api.czechia.com/api/Zmail/firma.cz/mailboxes/info

Ukázková odpověď:

{"message": "Schránka byla smazána"}

---

Dokumentace a podmínky

Detailní technická dokumentace API, včetně všech parametrů, modelů a testovacích požadavků, je dostupná ve Swagger rozhraní na adrese: https://api.czechia.com/swagger/index.html

Podmínky pro povolení REST API naleztenete na adrese: https://www.czechia.com/podminky-rest-api