Accesso all'account e al progetto
Utilizza un account API abilitato tramite HTTPS da un indirizzo IP consentito. Il progetto deve appartenere a tale account e non deve essere stato eliminato. Utilizza l'identificativo univoco del progetto ottenuto dal flusso dell'ordine di portabilità, non il suo identificativo numerico nel database né un numero di telefono. Applica la codifica URL all'identificativo del progetto quando costruisci una richiesta.
Richiesta
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/lnp/project/$PROJECT_ID"Trattare questa risposta come riservata
La risposta completa include le informazioni di fatturazione dell'operatore cedente, tra cui il valore memorizzato di billing_pin, il conto di fatturazione, il telefono, l'indirizzo, l'azienda e i dati del contatto autorizzato. L'API non maschera questi campi. Richiedi soltanto lo stato o l'elenco dei numeri quando il tuo flusso di lavoro necessita solo di questi dati. Non inserire la risposta completa di dettaglio nell'archiviazione del browser, nei sistemi di analisi, nei registri pubblici o nelle schermate destinate all'assistenza e mostra soltanto i campi necessari a un cliente autorizzato.
Struttura della risposta
Esempio fittizio con una selezione di campi; la risposta può contenere ulteriori campi.
{
"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": []
}
}Questo esempio volutamente parziale omette tutte le credenziali di fatturazione e i dati personali di contatto. La loro omissione dall'esempio non significa che la risposta reale li oscuri.
| Sezione | Contenuto |
|---|---|
| project | Identificativo numerico della riga, identificativo univoco del progetto, nome del progetto, ubicazione, dati memorizzati di fatturazione, contatto e indirizzo, data e ora di creazione e stato derivato. Il campo storico dell'operatore cedente è denominato loosing_carrier. |
| counts | Numero totale di righe relative ai numeri e contatori per Pending, In Progress, Completed e Rejected. |
| numbers | La stessa proiezione dei dati dei numeri restituita dall'endpoint dell'elenco dei numeri del progetto, inclusi i commenti del cliente e i valori di pianificazione memorizzati. |
| events | Righe degli eventi memorizzati e campi del contenuto grezzo o analizzato, soggetti ai limiti di visibilità e formato dell'endpoint degli eventi. |
| uploads | Metadati dei documenti: identificativo numerico, upload_type, file_name, file_extension, date_created e un download_url relativo. L'URL richiede comunque l'autenticazione dell'account. |
Interpretare il riepilogo e i metadati
Lo stato derivato assegna la priorità a In Progress, poi a Pending, quindi a Completed e infine a Rejected, con Pending come valore di ripiego. Un riepilogo con stato Completed può coesistere con numeri rifiutati. Controlla i contatori e gli stati dei numeri anziché presumere che la portabilità sia stata completata per ogni numero.
La risposta contiene i metadati dei documenti, non i byte dei file. Non prevede paginazione né un cursore incrementale. Le interrogazioni di dettaglio e dell'elenco sono letture separate e non costituiscono un'unica istantanea con coerenza transazionale garantita. Le date mantengono i valori memorizzati, senza una conversione di fuso orario documentata. Utilizza uniqueid per i percorsi del progetto; l'identificativo numerico del progetto non è intercambiabile con esso.
Errori e limiti
Controlla sia la risposta HTTP sia status.code/status.msg. Un progetto inesistente, eliminato o non appartenente all'account restituisce il codice API 404 con un messaggio che indica che il progetto non è stato trovato. Si applicano anche l'autenticazione e le restrizioni sull'indirizzo IP di origine. Gli esempi non effettuano richieste reali e una risposta riuscita non dimostra che un operatore abbia accettato o completato un trasferimento.
Effetti e flusso di lavoro
Questo è il percorso canonico di dettaglio utilizzato dalla vista degli ordini di portabilità del portale attuale. Il portale associa i campi alla propria interfaccia utente e applica la propria proiezione dei dati destinati al cliente; non presumere che la risposta grezza dell'API sia identica al JSON o alla presentazione del portale. Il gestore del dettaglio esaminato non modifica il progetto e non avvia direttamente una richiesta all'operatore né un addebito.