Vyžádání dokumentu
Použijte aktivovaný účet rozhraní API služby MultiTEL. U účtu s heslem odešlete přihlašovací údaje pro ověřování HTTP Basic, u účtu s tokenem odešlete token typu Bearer. Oprávnění účtu a omezení IP adres nadále platí. Nepoužívejte přihlašovací údaje interních pracovních procesů.
curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
--data-urlencode job_id=0123456789abcdef0123456789abcdef \
--dump-header fax-response.headers --output fax-response.bin \
https://api.multitel.net/v3/fax_downloadPoužijte stejný povinný hexadecimální identifikátor job_id o délce 32 znaků jako u fax_status. Zákaznický požadavek smí zadat pouze vlastník s ověřenou totožností. Tento příklad ukládá hlavičky odpovědi a její bajty odděleně, aby chyba rozhraní API nebyla zaměněna za soubor PDF.
Zpracování souboru nebo chyby ve formátu JSON
Při úspěchu se vracejí nezpracované bajty dokumentu s hlavičkami Content-Type a Content-Disposition pro přílohu, nikoli obálka ve formátu JSON. Než uložený soubor pojmenujete, otevřete nebo zpracujete, zkontrolujte tyto hlavičky. Odpověď může obsahovat soubor PDF, TIFF nebo soubor v původním nahraném formátu podle toho, který dokument je dostupný. U úlohy ve frontě může být před převodem vrácen původní zdrojový soubor.
Při neúspěchu se vrací obvyklá obálka ve formátu JSON se strukturou status/response. Kód rozhraní API 400 znamená, že job_id chybí nebo má nesprávný formát; 401 znamená chybějící ověření totožnosti; 404 znamená, že úloha nebo její soubor nejsou pro tento účet dostupné. Zkontrolujte Content-Type a status.code, i když je stav HTTP 200.
Dostupnost a ochrana soukromí
Záznam úlohy nezaručuje, že soubor bude možné stahovat navždy; doba uchovávání nebyla ověřena. Dokumenty, k nimž máte oprávnění, si podle potřeby ukládejte do vlastního úložiště, které máte pod kontrolou. Vrácený soubor může obsahovat soukromé údaje příjemce. Stažením se neodesílá nový fax.