Stažení přílohy projektu přenosu čísel

Přístup k účtu a dokumentům

Stáhněte existující přílohu z projektu přenosu čísel vlastněného vaším účtem API. Použijte aktivovaný účet API přes HTTPS z povolené IP adresy. Projekt nesmí být smazán. ID dokumentu se vyhledává v rámci daného projektu; nejde o globální veřejný odkaz ke stažení.

Určení dokumentu

Přečtěte si odpověď s podrobnostmi projektu a použijte položku ze seznamu uploads. Položka obsahuje číselné id, původní název souboru, uloženou příponu a relativní download_url. Použijte hodnotu projektu uniqueid a ID dané nahrané přílohy, nikoli číselné ID řádku projektu ani ID řádku telefonního čísla.

Vrácenou relativní adresu URL převádějte na úplnou adresu pouze vůči nakonfigurovanému důvěryhodnému hostiteli API. Stažení vyžaduje stejnou autentizaci účtu; metadata dokumentu neposkytují přístup bez autentizace.

Odeslání požadavku a uložení odpovědi

Nastavte PROJECT_ID a DOCUMENT_ID na hodnoty z projektu vašeho účtu. ID projektu zakódujte pro použití v URL. Tento příklad ukládá bajty a hlavičky odpovědi odděleně a používá pevně zvolený místní název výstupního souboru, místo aby důvěřoval názvu souboru přílohy.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --dump-header document-headers.txt \
  --output porting-document.bin \
  "https://api.multitel.net/v3/lnp/project/$PROJECT_ID/document/$DOCUMENT_ID"

Požadavek používá metodu GET bez těla. Načítá jednu celou přílohu, bez stránkování specifického pro tento koncový bod, bez obálky JSON a bez zdokumentovaných pravidel pro stahování rozsahů bajtů.

Binární odpověď a hlavičky

Při úspěchu tvoří tělo uložené bajty přílohy po dekódování staršího formátu úložiště, nikoli base64 ani objekt odpovědi JSON. Metoda odesílá hlavičku Content-Disposition označující přílohu s uloženým názvem souboru, z něhož jsou odstraněny dvojité uvozovky. Není zaručeno, že je hlavička kódována podle standardů nebo že představuje bezpečnou místní cestu k souboru; zvolte vlastní název cílového souboru.

Při porovnávání přípon se nerozlišují velká a malá písmena. Typ MIME se vybírá podle uložené přípony, nikoli na základě kontroly obsahu, a nezaručuje platnost dokumentu.

Ověření staženého souboru

1. Zkontrolujte stav HTTP i hlavičky odpovědi. Chyby autentizace nebo vyhledávání mohou místo souboru vrátit odpověď ve formátu JSON z API. Nepovažujte každé neprázdné tělo nebo uložený výstupní soubor za úspěšné stažení PDF.
2. Pokud tělo obsahuje chybu ve formátu JSON, zkontrolujte status.code a status.msg. Chybový výstup uchovávejte odděleně od očekávaného dokumentu.
3. Ověřte, že výsledný soubor není prázdný a lze jej otevřít jako očekávaný typ. Pokud máte původní soubor, porovnejte kontrolní součty, než se na kopii spolehnete.
4. Pokud je výsledek prázdný, neplatný nebo se liší od originálu, nepokračujte a požádejte podporu o kontrolu uložené přílohy. Opakované stahování úložiště neopraví.

Kompatibilita se starším způsobem ukládání

Současný postup nahrávání přes API a zkontrolované části portálu i starších systémů pro zápis nahrávaných souborů ukládají bajty dokumentů s escapováním. Toto stažení escapování odstraňuje. Offline testy skutečné obslužné funkce pro tento formát ukládání zachovávají všechny hodnoty bajtů i doslovná zpětná lomítka.

Nejde o záruku pro každý historický nebo externě importovaný záznam. Obslužná funkce vždy dekóduje uložený binární objekt a nezjišťuje, zda byl záznam importován bez očekávaného escapování. Pokud záznam neobsahuje uložený binární objekt, nepoužije ani náhradní načtení z cesty k souboru. Takové záznamy mohou vracet změněné bajty nebo prázdný obsah. Ověřte výsledek a požádejte podporu o prošetření dotčené přílohy; neupravujte dokument zákazníka ani nepředpokládejte, že jeho metadata dokazují dostupnost souboru.

Současný portál nejprve používá tuto cestu API a navíc má místní náhradní mechanismus. Úspěšné stažení přes portál nedokazuje, že lze každý starší záznam stáhnout přímo přes toto API.

Chyby a účinky

Pokud projekt chybí, je smazaný nebo jej váš účet nevlastní, vrátí se kód API 404 se zprávou, že projekt nebyl nalezen. Pokud nahraná příloha chybí v projektu vlastněném vaším účtem, vrátí se kód API 404 se zprávou, že dokument nebyl nalezen. Čtěte těla chybových odpovědí API i stav HTTP. Pro existující záznam, který nemá použitelné uložené bajty, tato obslužná funkce neposkytuje samostatnou spolehlivou odpověď oznamující nenalezení.

Zkontrolovaný koncový bod načítá jednu přílohu. Nenahrává, neupravuje ani neodstraňuje dokument, neodesílá žádost o přenos čísel ani nestrhává peníze z účtu. Přílohy k přenosu čísel mohou obsahovat údaje o totožnosti, fakturační údaje nebo informace o oprávnění: používejte je pouze v rámci oprávněných pracovních postupů účtu a nezahrnujte je do veřejných protokolů, analytických dat ani snímků obrazovky v dokumentaci.