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:
- získávat seznam existujících e-mailových schránek
- automaticky vytvářet a odstraňovat e-mailové schránky
- měnit hesla a velikost schránek
- spravovat e-mailové aliasy
- nastavovat přesměrování pošty
- nastavit, zda má při přesměrování zůstat kopie zpráv také v původní schránce
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. 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 – změna nastavení
- DELETE – odstranění položky
Aktivace REST API
Přístup k REST API aktivujete v Centru administrace, v detailu účtu. Podrobný návod naleznete v naší nápovědě na adrese https://napoveda.czechia.com/clanek/aktivace-rest-api/.
Seznam hlavních operací
1. Získání seznamu schránek
Vrátí informace o e-mailové službě na zadané doméně včetně seznamu existujících e-mailových schránek.
GET /api/Zmail/{domainName}/mailboxes
Ukázkový požadavek:
GET https://api.czechia.com/api/Zmail/firma.cz/mailboxes
2. Vytvoření nové schránky
Vytvoří novou e-mailovou schránku na zadané doméně.
POST /api/Zmail/{domainName}/mailboxes
Ukázkový požadavek:
POST https://api.czechia.com/api/Zmail/firma.cz/mailboxes Content-Type: application/json
Konkrétní parametry požadavku naleznete v technické dokumentaci REST API.
3. Změna hesla schránky
Nastaví nové heslo existující e-mailové schránky.
PUT /api/Zmail/{domainName}/mailboxes/{mailboxName}/pwd
Ukázkový požadavek:
PUT https://api.czechia.com/api/Zmail/firma.cz/mailboxes/info/pwd Content-Type: application/json
4. Změna velikosti schránky
Umožňuje nastavit velikost existující e-mailové schránky v MB.
PUT /api/Zmail/{domainName}/mailboxes/{mailboxName}/size
Ukázkový požadavek:
PUT https://api.czechia.com/api/Zmail/firma.cz/mailboxes/info/size Content-Type: application/json
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
Správa e-mailových aliasů
REST API umožňuje vytvářet a odstraňovat aliasy jednotlivých e-mailových schránek.
6. Získání seznamu aliasů
Vrátí seznam aliasů nastavených pro konkrétní e-mailovou schránku.
GET /api/Zmail/{domainName}/mailboxes/{mailboxName}/aliases
7. Vytvoření aliasu
Přidá ke konkrétní e-mailové schránce nový alias.
POST /api/Zmail/{domainName}/mailboxes/{mailboxName}/aliases
8. Smazání aliasu
Odstraní existující alias e-mailové schránky.
DELETE /api/Zmail/{domainName}/mailboxes/{mailboxName}/aliases/{aliasName}
Správa přesměrování
Pomocí REST API lze spravovat také přesměrování příchozí pošty z jednotlivých e-mailových schránek.
9. Získání seznamu přesměrování
Vrátí seznam přesměrování nastavených pro konkrétní e-mailovou schránku.
GET /api/Zmail/{domainName}/mailboxes/{mailboxName}/forwards
10. Vytvoření přesměrování
Přidá nové přesměrování příchozí pošty.
POST /api/Zmail/{domainName}/mailboxes/{mailboxName}/forwards
11. Nastavení lokální kopie
Umožňuje nastavit, zda má při aktivním přesměrování zůstat kopie přijaté zprávy také v původní e-mailové schránce.
PUT /api/Zmail/{domainName}/mailboxes/{mailboxName}/forwards/localcopy
12. Smazání přesměrování
Odstraní existující přesměrování e-mailové schránky.
DELETE /api/Zmail/{domainName}/mailboxes/{mailboxName}/forwards/{forwardName}
Dokumentace a podmínky
Kompletní technickou dokumentaci včetně aktuálního seznamu dostupných operací, parametrů požadavků a datových struktur naleznete v dokumentaci REST API: