Přístup k účtu a projektu
Použijte povolený účet API prostřednictvím HTTPS z povolené IP adresy. Projekt musí patřit tomuto účtu a nesmí být smazaný. Použijte jedinečný identifikátor projektu z pracovního postupu objednávky přenosu, nikoli jeho číselný databázový identifikátor ani telefonní číslo. Při sestavování požadavku použijte pro identifikátor projektu kódování URL.
Požadavek
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/lnp/project/$PROJECT_ID"S touto odpovědí zacházejte jako s důvěrnou
Úplná odpověď obsahuje fakturační údaje u opouštěného operátora, včetně uložené hodnoty billing_pin, fakturačního účtu, telefonu, adresy, společnosti a údajů o oprávněné kontaktní osobě. Rozhraní API tato pole nemaskuje. Pokud váš pracovní postup potřebuje pouze stav nebo seznam čísel, vyžádejte si pouze tyto údaje. Úplnou podrobnou odpověď neukládejte do úložiště prohlížeče, analytických systémů, veřejných protokolů ani snímků obrazovky pro podporu a zpřístupňujte pouze pole, která oprávněný zákazník potřebuje.
Struktura odpovědi
Smyšlený příklad s vybranými poli; odpověď může obsahovat i další pole.
{
"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": []
}
}Tento záměrně neúplný příklad vynechává všechny fakturační přihlašovací údaje a osobní kontaktní údaje. Jejich vynechání v příkladu neznamená, že je skutečná odpověď skrývá.
| Část | Obsah |
|---|---|
| project | Číselný identifikátor řádku, jedinečný identifikátor projektu, název projektu, lokalita, uložené fakturační, kontaktní a adresní údaje, čas vytvoření a odvozený stav. Starší pole pro opouštěného operátora má název loosing_carrier. |
| counts | Celkový počet řádků s čísly a počty pro stavy Pending, In Progress, Completed a Rejected. |
| numbers | Stejný výběr údajů o číslech jako u koncového bodu pro seznam čísel projektu, včetně komentářů zákazníka a uložených hodnot plánování. |
| events | Uložené řádky událostí a pole datového obsahu v nezpracované i rozparsované podobě, na které se vztahují omezení viditelnosti a formátu koncového bodu událostí. |
| uploads | Metadata dokumentů: číselný identifikátor, upload_type, file_name, file_extension, date_created a relativní download_url. Přístup na tuto URL stále vyžaduje autentizaci účtu. |
Výklad souhrnu a metadat
Při odvozování stavu má nejvyšší prioritu In Progress, poté Pending, následně Completed a nakonec Rejected; pokud nelze použít žádný z nich, použije se Pending. Souhrnný stav Completed se může vyskytovat i tehdy, když jsou některá čísla zamítnuta. Zkontrolujte počty a stavy jednotlivých čísel a nepředpokládejte, že byl přenos všech čísel dokončen.
Odpověď obsahuje metadata dokumentů, nikoli bajty souborů. Nepodporuje stránkování ani inkrementální kurzor. Dotazy na podrobnosti a seznam představují samostatná čtení, nikoli jeden snímek se zaručenou transakční konzistencí. Data zůstávají v uložené podobě bez zdokumentovaného převodu časového pásma. Pro cesty projektu používejte uniqueid; číselný identifikátor projektu nelze použít jako náhradu.
Chyby a omezení
Zkontrolujte jak odpověď HTTP, tak status.code/status.msg. Pokud projekt neexistuje, je smazaný nebo nepatří danému účtu, vrátí se kód API 404 se zprávou, že projekt nebyl nalezen. Platí také požadavky na autentizaci a omezení zdrojové IP adresy. Příklady neodesílají skutečný požadavek a úspěšná odpověď není důkazem, že operátor přenos přijal nebo dokončil.
Účinky a pracovní postup
Toto je kanonická cesta pro podrobnosti, kterou používá zobrazení objednávky přenosu v současném portálu. Portál mapuje pole pro své uživatelské rozhraní a používá vlastní výběr údajů pro zákazníka; nepředpokládejte, že nezpracovaná odpověď API je totožná s daty JSON portálu nebo s jeho zobrazením. Zkontrolovaná obslužná funkce pro podrobnosti nemění projekt ani přímo neodesílá požadavek operátorovi či neúčtuje poplatek.