Πρόσβαση στον λογαριασμό και στο έργο
Χρησιμοποιήστε έναν ενεργοποιημένο λογαριασμό API μέσω HTTPS από επιτρεπόμενη διεύθυνση IP. Το έργο πρέπει να ανήκει σε αυτόν τον λογαριασμό και να μην έχει διαγραφεί. Χρησιμοποιήστε το μοναδικό αναγνωριστικό του έργου από τη ροή της παραγγελίας φορητότητας, όχι το αριθμητικό αναγνωριστικό του στη βάση δεδομένων ούτε έναν αριθμό τηλεφώνου. Κατά τη δημιουργία ενός αιτήματος, εφαρμόστε κωδικοποίηση URL στο αναγνωριστικό του έργου.
Αίτημα
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/lnp/project/$PROJECT_ID"Χειριστείτε αυτή την απόκριση ως εμπιστευτική
Η πλήρης απόκριση περιλαμβάνει πληροφορίες χρέωσης του παρόχου από τον οποίο μεταφέρονται οι αριθμοί, συμπεριλαμβανομένης της αποθηκευμένης τιμής του billing_pin, του λογαριασμού χρέωσης, του τηλεφώνου, της διεύθυνσης, της εταιρείας και των στοιχείων του εξουσιοδοτημένου προσώπου επικοινωνίας. Το API δεν αποκρύπτει αυτά τα πεδία. Ζητήστε μόνο την κατάσταση ή τη λίστα αριθμών όταν η ροή εργασίας σας χρειάζεται μόνο αυτά τα δεδομένα. Μην αποθηκεύετε την πλήρη απόκριση λεπτομερειών στον χώρο αποθήκευσης του προγράμματος περιήγησης, σε συστήματα ανάλυσης, σε δημόσια αρχεία καταγραφής ή σε στιγμιότυπα οθόνης για την υποστήριξη και εμφανίζετε μόνο τα πεδία που χρειάζεται ένας εξουσιοδοτημένος πελάτης.
Δομή της απόκρισης
Πλασματικό παράδειγμα με επιλεγμένα πεδία· ενδέχεται να επιστραφούν επιπλέον πεδία.
{
"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": []
}
}Αυτό το σκόπιμα μερικό παράδειγμα παραλείπει όλα τα διαπιστευτήρια χρέωσης και τα προσωπικά στοιχεία επικοινωνίας. Η παράλειψή τους από το παράδειγμα δεν σημαίνει ότι η πραγματική απόκριση τα αποκρύπτει.
| Ενότητα | Περιεχόμενα |
|---|---|
| project | Αριθμητικό αναγνωριστικό γραμμής, μοναδικό αναγνωριστικό έργου, όνομα έργου, τοποθεσία, αποθηκευμένα δεδομένα χρέωσης, επικοινωνίας και διεύθυνσης, χρόνος δημιουργίας και υπολογιζόμενη κατάσταση. Το παλαιό πεδίο του παρόχου από τον οποίο μεταφέρονται οι αριθμοί γράφεται loosing_carrier. |
| counts | Συνολικό πλήθος γραμμών αριθμών και μετρητές για τις καταστάσεις Pending, In Progress, Completed και Rejected. |
| numbers | Η ίδια προβολή δεδομένων αριθμών με αυτή του τελικού σημείου της λίστας αριθμών του έργου, συμπεριλαμβανομένων των σχολίων του πελάτη και των αποθηκευμένων τιμών χρονοπρογραμματισμού. |
| events | Αποθηκευμένες γραμμές συμβάντων και πεδία του περιεχομένου σε ακατέργαστη ή αναλυμένη μορφή, με τους περιορισμούς ορατότητας και μορφής του τελικού σημείου συμβάντων. |
| uploads | Μεταδεδομένα εγγράφων: αριθμητικό αναγνωριστικό, upload_type, file_name, file_extension, date_created και μια σχετική διεύθυνση download_url. Η διεύθυνση URL εξακολουθεί να απαιτεί έλεγχο ταυτότητας του λογαριασμού. |
Ερμηνεία της σύνοψης και των μεταδεδομένων
Η υπολογιζόμενη κατάσταση δίνει προτεραιότητα στο In Progress, έπειτα στο Pending, κατόπιν στο Completed και τέλος στο Rejected, με το Pending ως εφεδρική τιμή. Μια σύνοψη με κατάσταση Completed μπορεί να συνυπάρχει με αριθμούς που έχουν απορριφθεί. Ελέγξτε τους μετρητές και τις καταστάσεις των αριθμών αντί να θεωρείτε ότι ολοκληρώθηκε η φορητότητα για κάθε αριθμό.
Η απόκριση περιέχει μεταδεδομένα εγγράφων, όχι τα byte των αρχείων. Δεν διαθέτει σελιδοποίηση ούτε αυξητικό δείκτη συνέχειας. Τα ερωτήματα λεπτομερειών και λίστας αποτελούν ξεχωριστές αναγνώσεις και όχι ένα ενιαίο στιγμιότυπο με εγγυημένη συναλλακτική συνέπεια. Οι ημερομηνίες παραμένουν στις αποθηκευμένες τιμές τους, χωρίς τεκμηριωμένη μετατροπή ζώνης ώρας. Χρησιμοποιήστε το uniqueid για τις διαδρομές του έργου· το αριθμητικό αναγνωριστικό του έργου δεν μπορεί να χρησιμοποιηθεί στη θέση του.
Σφάλματα και όρια
Ελέγξτε τόσο την απόκριση HTTP όσο και τα status.code/status.msg. Ένα έργο που δεν υπάρχει, έχει διαγραφεί ή δεν ανήκει στον λογαριασμό επιστρέφει κωδικό API 404 με μήνυμα ότι το έργο δεν βρέθηκε. Ισχύουν επίσης ο έλεγχος ταυτότητας και οι περιορισμοί της διεύθυνσης IP προέλευσης. Τα παραδείγματα δεν εκτελούν πραγματικό αίτημα και μια επιτυχής απόκριση δεν αποτελεί απόδειξη ότι κάποιος πάροχος έχει αποδεχτεί ή ολοκληρώσει μια μεταφορά.
Επιδράσεις και ροή εργασίας
Αυτή είναι η κανονική διαδρομή λεπτομερειών που χρησιμοποιεί η προβολή παραγγελιών φορητότητας της τρέχουσας πύλης. Η πύλη αντιστοιχίζει πεδία για τη διεπαφή χρήστη της και εφαρμόζει τη δική της προβολή δεδομένων για τον πελάτη· μην θεωρείτε ότι η ακατέργαστη απόκριση του API είναι ίδια με το JSON ή την παρουσίαση της πύλης. Ο χειριστής λεπτομερειών που εξετάστηκε δεν τροποποιεί το έργο ούτε ξεκινά απευθείας αίτημα προς πάροχο ή χρέωση.