Adgang til konto og projekt
Brug en aktiveret API-konto via HTTPS fra en tilladt IP-adresse. Projektet skal tilhøre denne konto og må ikke være slettet. Brug projektets entydige ID fra arbejdsgangen for porteringsordrer, ikke dets numeriske database-ID eller et telefonnummer. URL-kod projektets ID, når du opbygger en forespørgsel.
Forespørgsel
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/lnp/project/$PROJECT_ID"Behandl dette svar som fortroligt
Det fulde svar indeholder faktureringsoplysninger hos den afgivende operatør, herunder den gemte værdi for billing_pin, faktureringskontoen samt oplysninger om telefon, adresse, virksomhed og den bemyndigede kontaktperson. API'et maskerer ikke disse felter. Hent kun status eller nummerlisten, hvis det er alt, din arbejdsgang kræver. Undlad at gemme det fulde detaljesvar i browserlager, analysesystemer, offentlige logfiler og skærmbilleder til support, og vis kun de felter, som en autoriseret kunde har brug for.
Svarets struktur
Fiktivt eksempel med udvalgte felter; svaret kan indeholde yderligere felter.
{
"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": []
}
}Dette bevidst ufuldstændige eksempel udelader alle legitimationsoplysninger til fakturering og personlige kontaktoplysninger. At de er udeladt fra eksemplet, betyder ikke, at de skjules i det faktiske svar.
| Afsnit | Indhold |
|---|---|
| project | Numerisk række-ID, entydigt projekt-ID, projektnavn, placering, gemte fakturerings-, kontakt- og adresseoplysninger, oprettelsestidspunkt og afledt status. Det ældre felt for den afgivende operatør staves loosing_carrier. |
| counts | Samlet antal nummerrækker og tællere for Pending, In Progress, Completed og Rejected. |
| numbers | Det samme dataudsnit for numre som fra endepunktet for projektets nummerliste, inklusive kundekommentarer og gemte planlægningsværdier. |
| events | Gemte hændelsesrækker og felter med rå eller parsede nyttedata, underlagt hændelsesendepunktets begrænsninger for synlighed og format. |
| uploads | Dokumentmetadata: numerisk ID, upload_type, file_name, file_extension, date_created og en relativ download_url. URL'en kræver stadig autentificering med kontoen. |
Fortolk oversigten og metadataene
Den afledte status prioriterer In Progress, derefter Pending, så Completed og til sidst Rejected, med Pending som reserveværdi. En samlet status på Completed kan forekomme samtidig med afviste numre. Undersøg tællerne og numrenes status i stedet for at antage, at porteringen er gennemført for alle numre.
Svaret indeholder dokumentmetadata, ikke filernes byteindhold. Det har hverken sideinddeling eller en inkrementel markør. Detail- og listeforespørgslerne er separate læsninger, ikke ét øjebliksbillede med garanteret transaktionskonsistens. Datoer forbliver de gemte værdier uden en dokumenteret tidszonekonvertering. Brug uniqueid til projektruter; det numeriske projekt-ID kan ikke bruges i stedet.
Fejl og begrænsninger
Kontrollér både HTTP-svaret og status.code/status.msg. Et projekt, der mangler, er slettet eller ikke tilhører kontoen, returnerer API-kode 404 med en meddelelse om, at projektet ikke blev fundet. Krav om autentificering og begrænsninger for kilde-IP gælder også. Eksemplerne sender ikke en faktisk forespørgsel, og et vellykket svar er ikke bevis for, at en operatør har accepteret eller gennemført en portering.
Virkninger og arbejdsgang
Dette er den kanoniske detailrute, som den nuværende portals visning af porteringsordrer bruger. Portalen tilpasser felter til sin brugergrænseflade og anvender sit eget kundeorienterede dataudsnit; antag ikke, at det rå API-svar er identisk med portalens JSON eller visning. Den gennemgåede handler for projektdetaljer ændrer ikke projektet og igangsætter ikke direkte en forespørgsel til en operatør eller en opkrævning.