Juurdepääs kontole ja projektile
Kasutage lubatud IP-aadressilt aktiveeritud API kontot HTTPS ühenduse kaudu. Projekt peab kuuluma sellele kontole ega tohi olla kustutatud. Kasutage numbri üleviimise tellimuse töövoost saadud projekti kordumatut ID-d, mitte selle arvulist andmebaasi-ID-d ega telefoninumbrit. Päringu koostamisel kodeerige projekti ID URL-i jaoks.
Päring
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/lnp/project/$PROJECT_ID"Käsitlege seda vastust konfidentsiaalsena
Täielik vastus sisaldab selle operaatori arveldusandmeid, kelle juurest numbrid üle viiakse, sealhulgas salvestatud billing_pin, arvelduskonto, telefoni, aadressi, ettevõtte ja volitatud kontaktisiku andmeid. API ei varja neid välju. Kui töövoog vajab ainult olekut või numbrite loendit, küsige ainult neid. Ärge salvestage täielikku detailvastust brauseri salvestusruumi, analüütikasüsteemidesse, avalikesse logidesse ega kasutajatoele mõeldud kuvatõmmistele ning näidake ainult volitatud kliendile vajalikke välju.
Vastuse struktuur
Väljamõeldud näide valitud väljadega; vastuses võidakse tagastada ka lisavälju.
{
"status": {
"code": 200,
"msg": "Project Detail"
},
"response": {
"project": {
"id": 11,
"uniqueid": "PROJECT_EXAMPLE",
"project_name": "Example transfer",
"location": "US",
"status": 0,
"status_str": "Pending"
},
"counts": {
"total": 0,
"pending": 0,
"in_progress": 0,
"completed": 0,
"rejected": 0
},
"numbers": [],
"events": [],
"uploads": []
}
}Sellest teadlikult osalisest näitest on välja jäetud kõik arvelduse juurdepääsuandmed ja isiklikud kontaktandmed. Nende puudumine näitest ei tähenda, et tegelik vastus need varjaks.
| Jaotis | Sisu |
|---|---|
| project | Rea arvuline ID, projekti kordumatu ID, projekti nimi, asukoht, salvestatud arveldus-, kontakt- ja aadressiandmed, loomisaeg ning tuletatud olek. Selle operaatori pärandvälja nimi, kelle juurest numbrid üle viiakse, on loosing_carrier. |
| counts | Numbriridade koguarv ning olekute Pending, In Progress, Completed ja Rejected loendurid. |
| numbers | Sama numbrite andmevalik nagu projekti numbriloendi lõpp-punktil, sealhulgas kliendi kommentaarid ja salvestatud ajastamisväärtused. |
| events | Salvestatud sündmuseread ning töötlemata või parsitud andmesisu väljad, millele kehtivad sündmuste lõpp-punkti nähtavus- ja vormingupiirangud. |
| uploads | Dokumentide metaandmed: arvuline ID, upload_type, file_name, file_extension, date_created ja suhteline download_url. Ka sellele URL-ile juurdepääs nõuab konto autentimist. |
Kokkuvõtte ja metaandmete tõlgendamine
Tuletatud oleku määramisel eelistatakse olekut In Progress, seejärel Pending, siis Completed ja lõpuks Rejected; kui ükski neist ei kohaldu, kasutatakse olekut Pending. Kokkuvõtte olek Completed võib esineda ka siis, kui mõned numbrid on tagasi lükatud. Kontrollige loendureid ja numbrite olekuid, selle asemel et eeldada kõigi numbrite üleviimise lõppemist.
Vastus sisaldab dokumentide metaandmeid, mitte failide baite. Sellel pole lehekülgjaotust ega inkrementaalset kursorit. Üksikasjade ja loendi päringud on eraldi lugemistoimingud, mitte üks garanteeritult tehinguliselt kooskõlaline hetktõmmis. Kuupäevad jäävad salvestatud väärtusteks ning ajavööndi teisendamist pole dokumenteeritud. Kasutage projekti marsruutides välja uniqueid; projekti arvulist ID-d ei saa selle asemel kasutada.
Vead ja piirangud
Kontrollige nii HTTP vastust kui ka välju status.code/status.msg. Kui projekt puudub, on kustutatud või ei kuulu kontole, tagastatakse API kood 404 koos teatega, et projekti ei leitud. Kehtivad ka autentimise ja lähte-IP-aadressi piirangud. Näited ei tee tegelikku päringut ning edukas vastus ei tõenda, et operaator on üleviimise vastu võtnud või lõpetanud.
Mõju ja töövoog
See on kanooniline üksikasjade marsruut, mida kasutab praeguse portaali numbrite üleviimise tellimuse vaade. Portaal vastendab väljad oma kasutajaliidese jaoks ja rakendab oma kliendile mõeldud andmevalikut; ärge eeldage, et töötlemata API vastus on identne portaali JSON andmete või kuvatava teabega. Ülevaadatud üksikasjade töötleja ei muuda projekti ega algata otseselt operaatorile päringu saatmist või tasu võtmist.