Numbriliikuvusprojekti manuse allalaadimine

Juurdepääs kontole ja dokumendile

Laadige alla olemasolev manus numbriliikuvusprojektist, mis kuulub teie API kontole. Kasutage lubatud IP-aadressilt aktiivset API kontot HTTPS ühenduse kaudu. Projekt ei tohi olla kustutatud. Dokumendi ID-d otsitakse selle projekti piires; see ei ole üleüldine avalik allalaadimislink.

Leidke vajalik dokument

Lugege projekti üksikasjade vastust ja kasutage kirjet selle loendist uploads. Kirje sisaldab arvulist tunnust id, algset failinime, salvestatud faililaiendit ja suhtelist aadressi download_url. Kasutage projekti tunnust uniqueid ja selle üleslaadimise ID-d, mitte projekti rea arvulist ID-d ega telefoninumbri rea ID-d.

Lahendage tagastatud suhteline URL ainult teie seadistatud usaldusväärse API hosti suhtes. Allalaadimine nõuab sama konto autentimist; dokumendi metaandmed ei anna autentimata juurdepääsu.

Saatke päring ja salvestage vastus

Määrake PROJECT_ID ja DOCUMENT_ID väärtusteks oma konto projekti väärtused. Rakendage projekti ID-le URL-kodeering. See näide salvestab baidid ja vastuse päised eraldi ning kasutab kindlat kohalikku väljundfaili nime, selle asemel et usaldada manuse failinime.

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"

See on GET päring ilma sisuta. See loeb ühe tervikliku manuse; puuduvad lõpp-punktile eriomane lehekülgedeks jaotamine, JSON ümbris ja dokumenteeritud kokkulepe vahemike kaupa allalaadimise kohta.

Binaarne vastus ja päised

Õnnestumise korral sisaldab vastuse sisu manuse salvestatud baite pärast varasema salvestusvormingu dekodeerimist, mitte base64 kodeeringut ega JSON vastuseobjekti. Meetod saadab manuse päise Content-Disposition, kasutades salvestatud failinime, millest on eemaldatud jutumärgid. Ei ole tagatud, et päis on standardite järgi kodeeritud või et see annab turvalise kohaliku failitee; valige sihtfaili nimi ise.

Faililaiendite võrdlemisel ei eristata suur- ja väiketähti. MIME-tüüp valitakse salvestatud faililaiendi alusel, mitte sisu kontrollimise põhjal, ning see ei taga dokumendi kehtivust.

Kontrollige allalaaditud faili

1. Kontrollige nii HTTP olekut kui ka vastuse päiseid. Autentimis- või otsinguvigade korral võidakse faili asemel tagastada JSON vormingus API vastus. Ärge pidage iga mittetühja vastuse sisu või salvestatud väljundfaili õnnestunud PDF allalaadimiseks.
2. Kui vastuse sisu on JSON vormingus veateade, kontrollige välju status.code ja status.msg. Hoidke veaväljund oodatavast dokumendist eraldi.
3. Kontrollige, et saadud fail ei oleks tühi ja avaneks oodatud tüüpi failina. Kui originaal on alles, võrrelge koopia kontrollsummat originaali omaga, enne kui koopiale tuginete.
4. Kui tulemus on tühi, vigane või erineb originaalist, lõpetage ja paluge kasutajatoel salvestatud manust kontrollida. Korduvad allalaadimised ei paranda salvestusprobleeme.

Ühilduvus varasema salvestusvorminguga

Praegune API üleslaadimistee ning üle vaadatud portaali ja pärandsüsteemi üleslaadimiste kirjutuskomponendid salvestavad dokumendi baidid paomärkidega töödelduna. See allalaadimine tühistab paomärkidega töötlemise. Tegeliku töötleja võrguühenduseta testid kinnitavad, et selle salvestusvormingu korral säilivad kõik baidiväärtused ja sõnasõnalised längkriipsud.

See ei ole lubadus iga varasema või välisest allikast imporditud kirje kohta. Töötleja dekodeerib alati salvestatud binaarobjekti ega tuvasta, kas kirje imporditi ilma eeldatud paomärkidega töötlemiseta. Samuti ei kasuta see varuvariandina failiteed, kui kirjel puudub salvestatud binaarobjekt. Sellised kirjed võivad anda muudetud baite või tühja baidijada. Kontrollige tulemust ja laske kasutajatoel probleemset manust uurida, selle asemel et muuta kliendi dokumenti või eeldada, et selle metaandmed tõestavad faili kättesaadavust.

Praegune portaal kasutab esmalt seda API marsruuti ja sellel on lisaks kohalik varulahenduse töötlus. Edukas allalaadimine portaalist ei tõesta, et iga pärandkirjet saab otse selle API kaudu alla laadida.

Vead ja toimingu mõju

Puuduva, kustutatud või teie kontole mittekuuluva projekti korral tagastatakse API kood 404 koos teatega, et projekti ei leitud. Kui teie kontole kuuluvas projektis puudub üleslaadimine, tagastatakse API kood 404 koos teatega, et dokumenti ei leitud. Lugege nii API veavastuste sisu kui ka HTTP olekut. Olemasoleva kirje jaoks, millel puuduvad kasutatavad salvestatud baidid, ei ole selles töötlejas eraldi usaldusväärset vastust leidmata jätmise kohta.

Üle vaadatud lõpp-punkt loeb ühe manuse. See ei laadi dokumenti üles, ei muuda ega eemalda seda, ei esita numbriliikuvuse taotlust ega debiteeri kontot. Numbriliikuvuse manused võivad sisaldada isikuandmeid, arveldus- või volitusandmeid: kasutage neid ainult konto lubatud töövoogudes ning ärge lisage neid avalikesse logidesse, analüütikasse ega dokumentatsiooni kuvatõmmistele.