Izstrādātājiem

GET/v3/lnp/project/{uniqueid}/document/{documentId}

Lejupielādēt numuru pārnešanas projekta pielikumu

Lejupielādējiet savam kontam piederoša projekta dokumenta baitus un pārbaudiet saderību ar mantoto glabāšanas formātu.

Šajā lapā
  1. Piekļuve kontam un dokumentam
  2. Nosakiet vajadzīgo dokumentu
  3. Nosūtiet pieprasījumu un saglabājiet atbildi
  4. Binārā atbilde un galvenes
  5. Pārbaudiet lejupielādēto failu
  6. Saderība ar mantoto glabāšanas formātu
  7. Kļūdas un darbības ietekme

Piekļuve kontam un dokumentam

Lejupielādējiet esošu pielikumu no numuru pārnešanas projekta, kas pieder jūsu API kontam. Izmantojiet iespējotu API kontu un HTTPS savienojumu no atļautas IP adreses. Projekts nedrīkst būt dzēsts. Dokumenta ID tiek meklēts tikai šajā projektā; tā nav globāla publiska lejupielādes saite.

Nosakiet vajadzīgo dokumentu

Izlasiet atbildi ar projekta detalizēto informāciju un izmantojiet ierakstu no tā saraksta uploads. Ierakstā ir skaitliskais identifikators id, sākotnējais faila nosaukums, saglabātais paplašinājums un relatīvā adrese download_url. Izmantojiet projekta identifikatoru uniqueid un šīs augšupielādes ID, nevis projekta rindas skaitlisko ID vai tālruņa numura rindas ID.

Atgriezto relatīvo URL adresi atrisiniet tikai attiecībā pret jūsu konfigurēto, uzticamo API resursdatoru. Lejupielādei ir nepieciešama tā pati konta autentifikācija; dokumenta metadati nepiešķir piekļuvi bez autentifikācijas.

Nosūtiet pieprasījumu un saglabājiet atbildi

Iestatiet PROJECT_ID un DOCUMENT_ID atbilstoši vērtībām jūsu konta projektā. Kodējiet projekta ID izmantošanai URL adresē. Šajā piemērā baiti un atbildes galvenes tiek saglabāti atsevišķi, izmantojot fiksētu lokālā izvades faila nosaukumu, nevis paļaujoties uz pielikuma faila nosaukumu.

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"

Tas ir GET pieprasījums bez satura daļas. Tas nolasa vienu pilnu pielikumu; tam nav galapunktam specifiskas dalīšanas lapās, JSON ietvara vai dokumentētu nosacījumu lejupielādei pa diapazoniem.

Binārā atbilde un galvenes

Ja pieprasījums ir veiksmīgs, atbildes satura daļā ir pielikuma saglabātie baiti pēc mantotā glabāšanas formāta dekodēšanas, nevis base64 vai JSON atbildes objekts. Metode nosūta pielikuma galveni Content-Disposition, izmantojot saglabāto faila nosaukumu, no kura izņemtas dubultpēdiņas. Nav garantijas, ka galvene ir kodēta atbilstoši standartiem vai ka tā norāda drošu lokālā faila ceļu; izvēlieties savu mērķa faila nosaukumu.

Atbildes MIME tipi atkarībā no paplašinājuma
Saglabātais paplašinājumsContent-Type
pdfapplication/pdf
pngimage/png
jpg, jpegimage/jpeg
docapplication/msword
Citas vērtībasapplication/octet-stream

Salīdzinot paplašinājumus, lielie un mazie burti netiek atšķirti. MIME tips tiek izvēlēts pēc saglabātā paplašinājuma, nevis pārbaudot saturu, un tas negarantē dokumenta derīgumu.

Pārbaudiet lejupielādēto failu

  1. Pārbaudiet gan HTTP statusu, gan atbildes galvenes. Autentifikācijas vai meklēšanas kļūdu gadījumā faila vietā var tikt atgriezta JSON formāta API atbilde. Neuzskatiet katru netukšu atbildes satura daļu vai saglabātu izvades failu par veiksmīgu PDF lejupielādi.
  2. Ja atbildes satura daļā ir JSON formāta kļūda, pārbaudiet status.code un status.msg. Kļūdu izvadi glabājiet atsevišķi no gaidītā dokumenta.
  3. Pārbaudiet, vai iegūtais fails nav tukšs un vai tas atveras kā gaidītā tipa fails. Ja oriģināls ir saglabāts, pirms paļaujaties uz kopiju, salīdziniet tās kontrolsummu ar oriģināla kontrolsummu.
  4. Ja rezultāts ir tukšs, nederīgs vai atšķiras no oriģināla, pārtrauciet darbību un lūdziet atbalsta dienestam pārbaudīt saglabāto pielikumu. Atkārtotas lejupielādes neizlabo glabāšanas problēmas.

Saderība ar mantoto glabāšanas formātu

Pašreizējais API augšupielādes ceļš un pārskatītie portāla un mantotie augšupielādes ierakstīšanas komponenti saglabā dokumenta baitus ar ekranēšanu. Šī lejupielāde atceļ šo ekranēšanu. Faktiskā apstrādātāja bezsaistes testi apliecina, ka šim glabāšanas formātam tiek saglabātas visas baitu vērtības un burtiskās atpakaļvērstās slīpsvītras.

Tā nav garantija par katru vēsturisko vai no ārpuses importēto ierakstu. Apstrādātājs vienmēr dekodē saglabāto bināro datu objektu un nenosaka, vai ieraksts ir importēts bez paredzētās ekranēšanas. Ja ierakstam nav saglabāta bināro datu objekta, tas arī neizmanto faila ceļu kā rezerves risinājumu. Šādi ieraksti var atgriezt izmainītus baitus vai tukšu baitu virkni. Pārbaudiet rezultātu un lūdziet atbalsta dienestam izpētīt skarto pielikumu, nevis mainiet klienta dokumentu vai pieņemiet, ka tā metadati pierāda faila pieejamību.

Pašreizējais portāls vispirms izmanto šo API maršrutu, un tam ir papildu lokāla rezerves apstrāde. Veiksmīga lejupielāde portālā nepierāda, ka katru mantoto ierakstu var lejupielādēt tieši, izmantojot šo API.

Kļūdas un darbības ietekme

Ja projekts nepastāv, ir dzēsts vai nepieder jūsu kontam, tiek atgriezts API kods 404 ar ziņojumu, ka projekts nav atrasts. Ja augšupielāde nepastāv jūsu kontam piederošā projektā, tiek atgriezts API kods 404 ar ziņojumu, ka dokuments nav atrasts. Lasiet gan API kļūdu atbilžu saturu, gan HTTP statusu. Ierakstam, kas pastāv, bet kuram nav izmantojamu saglabāto baitu, šajā apstrādātājā nav atsevišķas, uzticamas atbildes par neatrašanu.

Pārskatītais galapunkts nolasa vienu pielikumu. Tas neaugšupielādē, nemaina un nedzēš dokumentu, neiesniedz numuru pārnešanas pieprasījumu un nenoraksta līdzekļus no konta. Numuru pārnešanas pielikumos var būt identitātes, norēķinu vai pilnvarojuma informācija: izmantojiet tos tikai atļautajās konta darbplūsmās un neiekļaujiet publiskos žurnālos, analītikā un dokumentācijas ekrānuzņēmumos.