Toegang tot die rekening en projek
Gebruik 'n geaktiveerde API-rekening oor HTTPS vanaf 'n toegelate IP-adres. Die projek moet aan daardie rekening behoort en mag nie uitgevee wees nie. Gebruik die projek se unieke identifiseerder uit die werkvloei vir oordragbestellings, nie die numeriese databasisidentifiseerder of 'n telefoonnommer nie. Pas URL-kodering op die projekidentifiseerder toe wanneer jy 'n versoek saamstel.
Versoek
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/lnp/project/$PROJECT_ID"Hanteer hierdie antwoord as vertroulik
Die volledige antwoord bevat faktureringsinligting vir die diensverskaffer van wie die nommers oorgedra word, insluitend die gestoorde billing_pin, faktureringsrekening, telefoonnommer, adres, maatskappybesonderhede en besonderhede van die gemagtigde kontakpersoon. Die API verberg nie hierdie velde nie. Vra slegs die status of nommerlys aan wanneer dit al is wat jou werkvloei benodig. Hou die volledige besonderhedeantwoord uit blaaierberging, ontledingstelsels, openbare logboeke en skermskote vir ondersteuning, en wys slegs die velde wat 'n gemagtigde kliënt nodig het.
Antwoordstruktuur
Fiktiewe voorbeeld met geselekteerde velde; bykomende velde kan teruggestuur word.
{
"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": []
}
}Hierdie doelbewus onvolledige voorbeeld laat alle aanmeldbesonderhede vir fakturering en persoonlike kontakwaardes weg. Die weglating daarvan uit die voorbeeld beteken nie dat die werklike antwoord dit verberg nie.
| Afdeling | Inhoud |
|---|---|
| project | Numeriese ry-identifiseerder, unieke projekidentifiseerder, projeknaam, ligging, gestoorde fakturerings-, kontak- en adresdata, skeppingstyd en afgeleide status. Die ou veld vir die diensverskaffer van wie die nommers oorgedra word, word loosing_carrier gespel. |
| counts | Totale aantal nommerrye en tellers vir Pending, In Progress, Completed en Rejected. |
| numbers | Dieselfde seleksie van nommerdata as by die eindpunt vir die projek se nommerlys, insluitend kliëntkommentaar en gestoorde skeduleringswaardes. |
| events | Gestoorde gebeurtenisrye en rou of ontlede dataladingvelde, onderhewig aan die sigbaarheids- en formaatbeperkings van die gebeurteniseindpunt. |
| uploads | Dokumentmetadata: numeriese identifiseerder, upload_type, file_name, file_extension, date_created en 'n relatiewe download_url. Die URL vereis steeds rekeningoutentisering. |
Vertolk die opsomming en metadata
Die afgeleide status gee voorrang aan In Progress, dan Pending, dan Completed en dan Rejected, met Pending as terugvalwaarde. 'n Opsomming met Completed kan saam met afgekeurde nommers voorkom. Gaan die tellers en nommerstatusse na eerder as om aan te neem dat elke nommer se oordrag voltooi is.
Die antwoord bevat dokumentmetadata, nie die lêer se grepe nie. Dit het geen bladsyverdeling of inkrementele wyser nie. Die navrae vir besonderhede en die lys lees die data afsonderlik; dit is nie een momentopname waarvan die transaksionele konsekwentheid gewaarborg is nie. Datums bly soos dit gestoor is, sonder 'n gedokumenteerde tydsone-omskakeling. Gebruik uniqueid vir projekroetes; die numeriese projekidentifiseerder kan nie in die plek daarvan gebruik word nie.
Foute en beperkings
Gaan sowel die HTTP-antwoord na as status.code/status.msg. 'n Projek wat ontbreek, uitgevee is of nie aan die rekening behoort nie, lewer API-kode 404 met 'n boodskap dat die projek nie gevind is nie. Outentiseringsvereistes en beperkings op die bron se IP-adres geld ook. Die voorbeelde voer nie 'n werklike versoek uit nie, en 'n suksesvolle antwoord bewys nie dat 'n diensverskaffer 'n oordrag aanvaar of voltooi het nie.
Uitwerking en werkvloei
Dit is die kanonieke besonderhederoete wat die huidige portaal se aansig vir oordragbestellings gebruik. Die portaal pas die velde vir sy gebruikerskoppelvlak aan en gebruik sy eie seleksie van data vir kliënte; moenie aanneem dat die rou API-antwoord identies is aan die portaal se JSON of weergawe op die skerm nie. Die nagegane besonderhedehanteerder verander nie die projek nie en begin ook nie regstreeks 'n versoek aan 'n diensverskaffer of 'n heffing nie.