Toegang tot die rekening en dokument
Laai 'n bestaande aanhegsel af van 'n nommeroordragprojek wat aan jou API-rekening behoort. Gebruik 'n geaktiveerde API-rekening oor HTTPS vanaf 'n toegelate IP-adres. Die projek mag nie geskrap wees nie. 'n Dokument-ID word binne daardie projek opgesoek; dit is nie 'n globale openbare aflaaiskakel nie.
Identifiseer die dokument
Lees die antwoord met die projekbesonderhede en gebruik 'n inskrywing uit die uploads-lys daarvan. Die inskrywing bevat die numeriese id, oorspronklike lêernaam, gestoorde uitbreiding en relatiewe download_url. Gebruik die projek se uniqueid en daardie oplaai-ID, nie die projek se numeriese ry-ID of die ry-ID van 'n nommer nie.
Bepaal die volledige adres vir 'n teruggestuurde relatiewe URL slegs op grond van jou gekonfigureerde, vertroude API-gasheer. Die aflaai vereis dieselfde rekeningoutentisering; dokumentmetadata verleen nie toegang sonder outentisering nie.
Versoek en stoor die antwoord
Stel PROJECT_ID en DOCUMENT_ID op waardes uit jou rekening se projek. Pas URL-kodering op die projek-ID toe. Hierdie voorbeeld stoor grepe en antwoordopskrifte afsonderlik en gebruik 'n vaste plaaslike uitvoernaam eerder as om die aanhegsel se lêernaam te vertrou.
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"Die versoek is GET sonder 'n liggaam. Dit lees een volledige aanhegsel, sonder eindpuntspesifieke paginering, 'n JSON-omhulsel of 'n gedokumenteerde kontrak vir die aflaai van grepe binne 'n bepaalde reeks.
Binêre antwoord en opskrifte
By sukses bevat die liggaam die aanhegsel se gestoorde grepe ná die dekoderingstap vir verouderde berging, nie base64 of 'n JSON-antwoordobjek nie. Die metode stuur 'n Content-Disposition-opskrif vir 'n aanhegsel met die gestoorde lêernaam, waaruit dubbele aanhalingstekens verwyder is. Daar is geen waarborg dat die opskrif volgens standaarde gekodeer is of 'n veilige plaaslike lêerpad is nie; kies jou eie bestemmingslêernaam.
| Gestoorde uitbreiding | Content-Type |
|---|---|
| application/pdf | |
| png | image/png |
| jpg, jpeg | image/jpeg |
| doc | application/msword |
| Ander waardes | application/octet-stream |
Die vergelyking van uitbreidings is nie hooflettersensitief nie. Die MIME-tipe word volgens die gestoorde uitbreiding gekies, nie deur die inhoud te ondersoek nie, en dit waarborg nie dat die dokument geldig is nie.
Verifieer die afgelaaide lêer
- Ondersoek sowel die HTTP-status as die antwoordopskrifte. Outentiserings- of opsoekfoute kan 'n JSON-antwoord van die API in plaas van 'n lêer terugstuur. Moenie elke liggaam wat nie leeg is nie of elke gestoorde uitvoerlêer as 'n suksesvolle PDF-aflaai beskou nie.
- As die liggaam 'n JSON-fout is, ondersoek
status.codeenstatus.msg. Hou foutuitvoer apart van die verwagte dokument. - Maak seker dat die resulterende lêer nie leeg is nie en as die verwagte tipe oopmaak. As jy die oorspronklike behou het, vergelyk die kontrolesomme voordat jy op die kopie staatmaak.
- As die resultaat leeg of ongeldig is, of van die oorspronklike verskil, stop en vra die ondersteuningspan om die gestoorde aanhegsel na te gaan. Herhaalde aflaaie herstel nie die berging nie.
Versoenbaarheid met verouderde berging
Die huidige API-oplaaipad en die nagegane skryfkomponente vir oplaaie in die portaal en verouderde stelsels stoor dokumentgrepe met ontsnappingskodering. Hierdie aflaai maak daardie ontsnappingskodering ongedaan. Vanlyn toetse van die werklike hanteerder behou alle greepwaardes en letterlike terugskuinsstrepe vir daardie bergingsformaat.
Dit is nie 'n belofte oor elke historiese of ekstern ingevoerde rekord nie. Die hanteerder dekodeer altyd die gestoorde binêre objek en bespeur nie of 'n rekord sonder die verwagte ontsnappingskodering ingevoer is nie. Dit val ook nie op 'n lêerpad terug wanneer 'n rekord geen gestoorde binêre objek het nie. Sulke rekords kan gewysigde grepe of 'n leë resultaat oplewer. Verifieer die resultaat en laat die ondersteuningspan 'n geraakte aanhegsel ondersoek, eerder as om 'n kliënt se dokument te wysig of aan te neem dat die metadata bewys dat die lêer beskikbaar is.
Die huidige portaal gebruik eers hierdie API-roete en het bykomende plaaslike terugvalhantering. 'n Suksesvolle aflaai deur die portaal bewys nie dat elke verouderde rekord direk deur hierdie API afgelaai kan word nie.
Foute en uitwerkings
'n Projek wat ontbreek, geskrap is of nie aan jou behoort nie, stuur API-kode 404 terug met 'n boodskap dat die projek nie gevind is nie. 'n Ontbrekende oplaai binne 'n projek wat aan jou behoort, stuur API-kode 404 terug met 'n boodskap dat die dokument nie gevind is nie. Lees die API-foutliggame sowel as die HTTP-status. Vir 'n rekord wat bestaan maar nie bruikbare gestoorde grepe het nie, het hierdie hanteerder geen toegewyde, betroubare antwoord wat aandui dat dit nie gevind is nie.
Die nagegane eindpunt lees een aanhegsel. Dit laai nie 'n dokument op, wysig of verwyder dit nie, dien nie 'n nommeroordragversoek in nie en debiteer nie die rekening nie. Aanhegsels vir nommeroordrag kan identiteits-, fakturering- of magtigingsinligting bevat: hou dit binne gemagtigde rekeningwerkvloeie en uit openbare logboeke, ontledings en skermgrepe vir dokumentasie.