Jak funguje API sendBox.cz?

sendBox.cz nabízí bezpečné rozhraní API, které umožňuje odesílat zabezpečené zprávy z Vašeho software nebo např. online aplikace. API je vždy propojeno s jedním existujícím uživatelským účtem a zprávy zasílané přes API jsou vždy odesílány přes tento účet, odesílatelem zpráv je vždy tento účet a účet obsahuje přes API odeslané zprávy v Odeslané poště. Pokud při své činnosti zpracováváte osobní údaje, umožní vám systém sendBox.cz díky své vysoké úrovni zabezpečení uchovat osobní data, která bude obsahovat korespondence, v takovém režimu, který zcela odpovídá požadavkům GDPR.

Pro aktivaci API rozhraní musíte nejprve provést registraci (pokud jí ještě nemáte) na email ze kterého následně budou API zprávy zasílány. Následně v sekci Nastavení povolte Povolit rozhraní API.

Video, aktivace a nastavení API

Popis rozhraní API

Odeslání zpráv se provádí odesláním jednoduchého HTTP požadavku metodou GET na https://sendbox.cz/api_sender.php.

Volání GET musí obsahovat povinné parametry:

$sender_hash musí obsahovat HASH získaný při registraci API

$sender_key musí obsahovat 8-místný KLÍČ získaný při registraci API

$recipient musí obsahovat email adresu příjemce / adresáta zprávy (max. 128 znaků)

$expire musí obsahovat počet dnů platnosti zprávy (min. 1, max. 60)

$subject musí obsahovat předmět zprávy, diakritika povolena (min. 4, max. 256 znaků)

$body musí obsahovat text zprávy (min. 4 znaky)

Volání GET může obsahovat nepovinné parametry:

$url_attachment může obsahovat URL adresu souboru který bude přiložen ke zprávě (URL musí být na nastavené doméně)

$encryption může obsahovat šifrovací heslo pro šifrování zprávy a přílohy (min. 1, max. 128 znaků)

Příklad volání API:

https://sendbox.cz/api_sender.php?sender_hash=[API HASH]&sender_key=[API KLÍČ]&recipient=[EMAIL PŘÍJEMCE]&expire=[POČET DNŮ]&subject=[PŘEDMĚT ZPRÁVY]&body=[TĚLO ZPRÁVY]

Skript odpovídá na volání chybovým oznámením nebo textem OK v případě že zpráva byla odeslána.

Důležitá specifika rozhraní API

1. Zabezpečte na Vaší straně $sender_hash, $sender_key i samotný skript aby nemohlo dojít k jejich zneužití na straně serveru.

2. Rozhraní API lze používat pouze pokud je na účtu nastaven tarif Premium.

3. Volání skiptu může být úspěšné pouze z IP adresy registrované v Nastavení API, adresu IP můžete změnit dle potřeby, vždy může být ale jen jedna.

4. Pokud ke zprávě přikládáte soubor musí jeho URL být na doméně, která je registrovaná v Nastavení API.

5. Pokud má zpráva stejného příjemce a předmět lze jí poslat znovu nejdříve za 10 minut. To slouží jako ochrana před nechtěným opakovaným odesláním.

6. Základní limit pro rozhraní API je nastaven na 50 zpráv za 24 hodin, pokud požadujete jiný zašlete nám požadavek sendboxem na info@sendbox.cz.

7. Nezapomínejte pro parametry použít urlencode aby mohla být zpráva v pořádku zpracována.

8. Zprávy zpracované přes rozhraní API jsou zpracovávány okamžitě, přesto, automaticky generované zprávy, pokud je to možné, posílejte v noci.

9. Rozhraní API umožňuje za účelem testování poslat zprávu příjemci, který má stejnou adresu jako odesílatel.

10. Zprávy odeslané přes rozhraní API můžete zobrazit po přihlášení v sekci Odeslané.

11. Maximální možná doba expirace zprávy odeslané přes API je 60 dnů.