Tilin ja asiakirjan käyttöoikeudet
Lataa olemassa oleva liite API-tilisi omistamasta numeronsiirtoprojektista. Käytä käyttöön otettua API-tiliä HTTPS-yhteydellä sallitusta IP-osoitteesta. Projekti ei saa olla poistettu. Asiakirjan tunniste haetaan kyseisen projektin sisältä; se ei ole yleinen julkinen latauslinkki.
Yksilöi asiakirja
Lue projektin tiedot sisältävä vastaus ja valitse tietue sen uploads-luettelosta. Tietue sisältää numeerisen tunnisteen id, alkuperäisen tiedostonimen, tallennetun tiedostopäätteen ja suhteellisen osoitteen download_url. Käytä projektin tunnistetta uniqueid ja kyseisen latauksen tunnistetta, älä projektin numeerista rivitunnistetta tai puhelinnumeron rivitunnistetta.
Muodosta palautetusta suhteellisesta URL-osoitteesta täydellinen osoite vain määrittämäsi luotetun API-palvelimen perusteella. Lataus edellyttää samaa tilin todennusta; asiakirjan metatiedot eivät anna pääsyä ilman todennusta.
Lähetä pyyntö ja tallenna vastaus
Aseta PROJECT_ID ja DOCUMENT_ID tilisi projektista saatuihin arvoihin. URL-koodaa projektin tunniste. Tämä esimerkki tallentaa tavut ja vastausotsakkeet erikseen ja käyttää kiinteää paikallista tulostiedoston nimeä sen sijaan, että luottaisi liitteen tiedostonimeen.
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"Pyyntö käyttää GET-menetelmää ilman runkoa. Se lukee yhden kokonaisen liitteen ilman päätepistekohtaista sivutusta, JSON-käärettä tai dokumentoitua sopimusta tavualueiden lataamisesta.
Binäärinen vastaus ja otsakkeet
Onnistuneen vastauksen runko sisältää liitteen tallennetut tavut vanhan tallennusmuodon dekoodauksen jälkeen, ei base64-koodattua sisältöä eikä JSON-vastausobjektia. Menetelmä lähettää liitteen Content-Disposition-otsakkeen käyttäen tallennettua tiedostonimeä, josta on poistettu kaksinkertaiset lainausmerkit. Otsakkeen ei taata olevan standardien mukaisesti koodattu eikä turvallinen paikallinen tiedostopolku; valitse kohdetiedostolle oma nimi.
| Tallennettu tiedostopääte | Content-Type |
|---|---|
| application/pdf | |
| png | image/png |
| jpg, jpeg | image/jpeg |
| doc | application/msword |
| Muut arvot | application/octet-stream |
Tiedostopäätteiden vertailussa ei erotella isoja ja pieniä kirjaimia. MIME-tyyppi valitaan tallennetun tiedostopäätteen perusteella, ei sisältöä tarkastamalla, eikä valinta takaa asiakirjan kelvollisuutta.
Tarkista ladattu tiedosto
- Tarkista sekä HTTP-tila että vastausotsakkeet. Todennus- tai hakuvirhe voi palauttaa tiedoston sijaan JSON-muotoisen API-vastauksen. Älä tulkitse jokaista sisältöä sisältävää vastausrunkoa tai tallennettua tulostiedostoa onnistuneeksi PDF-lataukseksi.
- Jos runko sisältää JSON-muotoisen virheen, tarkista
status.codejastatus.msg. Pidä virhetuloste erillään odotetusta asiakirjasta. - Tarkista, ettei tuloksena saatu tiedosto ole tyhjä ja että se avautuu odotetun tyyppisenä. Jos alkuperäinen tiedosto on tallessa, vertaa tarkistussummia ennen kuin luotat kopioon.
- Jos tulos on tyhjä, virheellinen tai poikkeaa alkuperäisestä, lopeta ja pyydä tukea tarkistamaan tallennettu liite. Toistuvat lataukset eivät korjaa tallennusta.
Yhteensopivuus vanhan tallennusmuodon kanssa
Nykyinen API-latauspolku sekä tarkastetut portaalin ja vanhojen järjestelmien latausten kirjoitustoteutukset tallentavat asiakirjojen tavut escape-koodattuina. Tämä lataus purkaa kyseisen escape-koodauksen. Varsinaisen käsittelijän offline-testit säilyttävät kaikki tavuarvot ja kirjaimelliset kenoviivat tässä tallennusmuodossa.
Tämä ei ole lupaus kaikkien historiallisten tai ulkoisista lähteistä tuotujen tietueiden toimivuudesta. Käsittelijä dekoodaa aina tallennetun binääritieto-objektin eikä tunnista, onko tietue tuotu ilman odotettua escape-koodausta. Se ei myöskään käytä tiedostopolkua varavaihtoehtona, jos tietueessa ei ole tallennettua binääritieto-objektia. Tällaiset tietueet voivat tuottaa muuttuneita tavuja tai tyhjän tuloksen. Tarkista tulos ja pyydä tukea tutkimaan kyseinen liite sen sijaan, että muuttaisit asiakkaan asiakirjaa tai olettaisit metatietojen todistavan tiedoston olevan saatavilla.
Nykyinen portaali käyttää ensisijaisesti tätä API-reittiä, minkä lisäksi siinä on paikallista varakäsittelyä. Onnistunut lataus portaalista ei todista, että kaikki vanhat tietueet voidaan ladata suoraan tämän API-rajapinnan kautta.
Virheet ja vaikutukset
Jos projekti puuttuu, on poistettu tai ei ole tilin omistama, palautetaan API-koodi 404 ja ilmoitus siitä, ettei projektia löytynyt. Jos tilin omistamasta projektista puuttuu lataus, palautetaan API-koodi 404 ja ilmoitus siitä, ettei asiakirjaa löytynyt. Lue API-virhevastausten rungot sekä HTTP-tila. Olemassa olevalle tietueelle, josta puuttuvat käyttökelpoiset tallennetut tavut, ei ole tässä käsittelijässä omaa luotettavaa vastausta, joka ilmoittaisi sisällön puuttumisesta.
Tarkastettu päätepiste lukee yhden liitteen. Se ei lähetä, muokkaa eikä poista asiakirjaa, lähetä numeronsiirtopyyntöä eikä veloita tiliä. Numeronsiirron liitteet voivat sisältää henkilöllisyys-, laskutus- tai valtuutustietoja: käsittele niitä vain tilin valtuutetuissa työnkuluissa ja pidä ne poissa julkisista lokeista, analytiikasta ja dokumentaation kuvakaappauksista.