Pristup računu i projektu
Upotrijebite omogućen račun za API putem protokola HTTPS s dopuštene IP adrese. Projekt mora pripadati tom računu i ne smije biti izbrisan. Upotrijebite jedinstveni identifikator projekta iz tijeka rada za narudžbu prijenosa brojeva, a ne njegov numerički identifikator u bazi podataka ili telefonski broj. Pri sastavljanju zahtjeva primijenite URL kodiranje na identifikator projekta.
Zahtjev
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/lnp/project/$PROJECT_ID"S ovim odgovorom postupajte kao s povjerljivim podacima
Potpuni odgovor uključuje podatke za naplatu kod operatora davatelja broja, uključujući pohranjenu vrijednost polja billing_pin, račun za naplatu te podatke o telefonu, adresi, tvrtki i ovlaštenoj osobi za kontakt. API ne maskira ta polja. Zatražite samo status ili popis brojeva ako je to sve što vaš tijek rada zahtijeva. Potpuni odgovor s pojedinostima nemojte spremati u pohranu preglednika, analitičke sustave, javne zapisnike ni snimke zaslona za podršku, a prikažite samo polja koja su potrebna ovlaštenom korisniku.
Struktura odgovora
Izmišljeni primjer s odabranim poljima; odgovor može sadržavati dodatna polja.
{
"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": []
}
}Ovaj namjerno nepotpuni primjer izostavlja sve vjerodajnice za naplatu i osobne podatke za kontakt. Njihovo izostavljanje iz primjera ne znači da ih stvarni odgovor skriva.
| Odjeljak | Sadržaj |
|---|---|
| project | Numerički identifikator retka, jedinstveni identifikator projekta, naziv projekta, lokacija, pohranjeni podaci za naplatu, kontakt i adresu, vrijeme stvaranja i izvedeni status. Naslijeđeno polje za operatora davatelja broja piše se loosing_carrier. |
| counts | Ukupan broj redaka s brojevima i brojači za statuse Pending, In Progress, Completed i Rejected. |
| numbers | Isti odabir podataka o brojevima kao na krajnjoj točki za popis brojeva projekta, uključujući komentare korisnika i pohranjene vrijednosti rasporeda. |
| events | Pohranjeni retci događaja i polja sa sirovim ili raščlanjenim sadržajem poruke, uz ograničenja vidljivosti i formata krajnje točke za događaje. |
| uploads | Metapodaci dokumenta: numerički identifikator, upload_type, file_name, file_extension, date_created i relativni download_url. URL i dalje zahtijeva autentifikaciju računa. |
Tumačenje sažetka i metapodataka
Pri određivanju izvedenog statusa prednost ima In Progress, zatim Pending, pa Completed, a potom Rejected, uz Pending kao pričuvnu vrijednost. Sažeti status Completed može se pojaviti i kada postoje odbijeni brojevi. Provjerite brojače i statuse brojeva umjesto da pretpostavite da je prijenos dovršen za svaki broj.
Odgovor sadrži metapodatke dokumenata, a ne bajtove datoteka. Nema podjelu na stranice ni inkrementalni kursor. Upiti za pojedinosti i popise zasebna su čitanja, a ne jedna snimka stanja sa zajamčenom transakcijskom dosljednošću. Datumi ostaju pohranjene vrijednosti bez dokumentirane pretvorbe vremenske zone. Za rute projekta upotrijebite uniqueid; numerički identifikator projekta ne može se upotrijebiti umjesto njega.
Pogreške i ograničenja
Provjerite i odgovor protokola HTTP i status.code/status.msg. Ako projekt ne postoji, izbrisan je ili ne pripada računu, vraća se kod API-ja 404 s porukom da projekt nije pronađen. Primjenjuju se i zahtjevi za autentifikaciju te ograničenja izvorne IP adrese. Primjeri ne šalju stvarni zahtjev, a uspješan odgovor nije dokaz da je operator prihvatio ili dovršio prijenos.
Učinci i tijek rada
Ovo je kanonska ruta za pojedinosti koju upotrebljava prikaz narudžbi prijenosa brojeva na trenutačnom portalu. Portal preslikava polja za svoje korisničko sučelje i primjenjuje vlastiti odabir podataka za korisnika; nemojte pretpostaviti da je sirovi odgovor API-ja jednak portalovu zapisu u formatu JSON ili njegovu prikazu. Pregledani obrađivač pojedinosti ne mijenja projekt niti izravno pokreće zahtjev operatoru ili naplatu.