Piekļuve kontam un projektam
Izmantojiet iespējotu API kontu ar HTTPS savienojumu no atļautas IP adreses. Projektam jāpieder šim kontam, un tas nedrīkst būt dzēsts. Izmantojiet projekta unikālo identifikatoru no numuru pārnešanas pasūtījuma darbplūsmas, nevis tā skaitlisko datubāzes identifikatoru vai tālruņa numuru. Veidojot pieprasījumu, kodējiet projekta identifikatoru URL formātā.
Pieprasījums
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/lnp/project/$PROJECT_ID"Apstrādājiet šo atbildi kā konfidenciālu informāciju
Pilnā atbilde ietver tā operatora norēķinu informāciju, no kura numuri tiek pārnesti, tostarp saglabāto billing_pin, norēķinu kontu, tālruni, adresi, uzņēmuma un pilnvarotās kontaktpersonas datus. API šos laukus nemaskē. Pieprasiet tikai statusu vai numuru sarakstu, ja ar to pietiek jūsu darbplūsmai. Neglabājiet pilno detalizēto atbildi pārlūka krātuvē, analītikas sistēmās, publiskos žurnālos vai atbalstam paredzētos ekrānuzņēmumos un rādiet tikai tos laukus, kas nepieciešami pilnvarotam klientam.
Atbildes struktūra
Izdomāts piemērs ar atlasītiem laukiem; atbildē var tikt atgriezti arī papildu lauki.
{
"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": []
}
}Šajā apzināti nepilnīgajā piemērā nav iekļauti nekādi norēķinu piekļuves dati vai personu kontaktinformācijas vērtības. To neiekļaušana piemērā nenozīmē, ka īstajā atbildē šie dati tiek aizklāti.
| Sadaļa | Saturs |
|---|---|
| project | Skaitlisks rindas identifikators, unikāls projekta identifikators, projekta nosaukums, atrašanās vieta, saglabātie norēķinu, kontaktinformācijas un adreses dati, izveides laiks un atvasinātais statuss. Mantotā lauka nosaukums operatoram, no kura numuri tiek pārnesti, ir loosing_carrier. |
| counts | Numuru rindu kopskaits un statusu Pending, In Progress, Completed un Rejected skaitītāji. |
| numbers | Tā pati numuru datu atlase, ko atgriež projekta numuru saraksta galapunkts, tostarp klienta komentāri un saglabātās plānošanas vērtības. |
| events | Saglabātās notikumu rindas un neapstrādāti vai parsēti satura lauki, ievērojot notikumu galapunkta redzamības un formāta ierobežojumus. |
| uploads | Dokumentu metadati: skaitlisks identifikators, upload_type, file_name, file_extension, date_created un relatīvs download_url. Arī piekļuvei šim URL ir nepieciešama konta autentifikācija. |
Kopsavilkuma un metadatu interpretēšana
Atvasinātais statuss dod priekšroku In Progress, pēc tam Pending, tad Completed un visbeidzot Rejected; ja neviens no tiem nav piemērojams, tiek izmantots Pending. Kopsavilkuma statuss Completed var pastāvēt arī tad, ja ir noraidīti numuri. Pārbaudiet skaitītājus un numuru statusus, nevis pieņemiet, ka visu numuru pārnešana ir pabeigta.
Atbilde satur dokumentu metadatus, nevis failu baitus. Tai nav ne dalījuma lapās, ne inkrementāla kursora. Detalizētās informācijas un saraksta vaicājumi ir atsevišķas nolasīšanas darbības, nevis viens garantēti transakcionāli konsekvents momentuzņēmums. Datumi paliek saglabātajās vērtībās bez dokumentētas laika joslas pārveidošanas. Projekta maršrutiem izmantojiet uniqueid; skaitlisko projekta identifikatoru tā vietā izmantot nevar.
Kļūdas un ierobežojumi
Pārbaudiet gan HTTP atbildi, gan status.code/status.msg. Ja projekts neeksistē, ir dzēsts vai nepieder kontam, tiek atgriezts API kods 404 ar ziņojumu, ka projekts nav atrasts. Piemēro arī autentifikācijas un avota IP adreses ierobežojumus. Piemēri neveic reālu pieprasījumu, un veiksmīga atbilde nepierāda, ka operators ir pieņēmis vai pabeidzis numuru pārnešanu.
Ietekme un darbplūsma
Šis ir kanoniskais detalizētās informācijas maršruts, ko izmanto pašreizējā portāla numuru pārnešanas pasūtījuma skats. Portāls pārveido laukus savai lietotāja saskarnei un piemēro savu klientam paredzēto datu atlasi; nepieņemiet, ka neapstrādātā API atbilde ir identiska portāla JSON datiem vai attēlojumam. Pārskatītais detalizētās informācijas apstrādātājs nemaina projektu un tieši neuzsāk ne pieprasījumu operatoram, ne maksas iekasēšanu.