Dokumentacioni i REST API
API REST për kërkimin e rrugëzimit LRN
Kërkoni numrin e rrugëzimit dhe informacionin e disponueshëm të operatorit për një numër telefoni të Amerikës së Veriut me çmim fiks.
Zgjidhni API-në dhe kredencialin së bashku
Llogaritë e miratuara të kategorive Zhvillues dhe automatizim, Biznes dhe Ofrues të komunikimeve mund të integrojnë shërbimet e aktivizuara. Një zhvillues individual nuk ka nevojë të hiqet si kompani. SMS/MMS e aplikacionit kërkon miratimin dhe regjistrimin përkatës të dërgimit. Shërbimi Individë dhe familje nuk ka API të aksesueshme nga klienti për të nisur dërgimin e mesazheve.
| Familja API | URL bazë | Vërtetimi dhe rezultati |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Kredenciale Basic të miratuara; tokenë të siguruar të pranueshëm vetëm për operacionet që i mbështesin. JSON status dhe response. |
| Regjistrimi për shërbimin e thirrjeve të emergjencës | https://api.multi.tel/emergency | Kredenciale Basic të miratuara ose akses bearer i siguruar posaçërisht. JSON code, message dhe data. |
| Integrimet REST të portalit | Hosti dhe operacioni tregohen në referencën e zhvilluesit të llogarisë suaj | Përdorni kredencialin, fushëveprimin e lejeve dhe skemën e dokumentuar të atij operacioni. Kërkesat e sesionit të shfletuesit përdorin një ndërfaqe të veçantë. |
Vendosni MULTITEL_API_USERNAME dhe MULTITEL_API_PASSWORD përmes konfigurimit sekret të serverit tuaj përpara se të përdorni shembujt. Mos i ngulitni kurrë në JavaScript publik të shfletuesit, në URL ose në kontrollin e burimit. Kredencialet e dedikuara menaxhohen te Cilësimet e Integrimit API.
Kërkoni një numër
GET /v3/lrn/{number} pranon numrin e destinacionit në shteg. Numri i telefonuesit mund të jepet sipas dëshirës si /v3/lrn/{number}/{ani} për informacionin që varet nga origjina e thirrjes. Jepni numra telefoni të Amerikës së Veriut vetëm me shifra dhe me kodin e shtetit kur nevojitet; shembujt përdorin numra imagjinarë të rezervuar.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/lrn/12025550123"curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/lrn/12025550123/12025550124"Ekzekutimi i një kërkimi me kredenciale të vlefshme është i faturueshëm. Tarifa është 0,00025 US$ për kërkim: 0,25 US$ për 1000 ose 250 US$ për milion. Nuk ka zbritje vëllimi. Ky është një kërkim informacioni rutimi; ai nuk kryen një telefonatë.
Lexoni rezultatin
{
"status": {
"code": 200,
"msg": "Success"
},
"response": {
"lrn": "12025550123",
"ported": 0,
"ocn": "",
"lata": "",
"rc": "",
"cost": "$0.00025"
}
}Ky shembull i trilluar demonstron vetëm formën e përgjigjes; ai nuk është një rezultat i matur rutimi. Kontrolloni status.code përpara se të përdorni response. Fusha cost është një varg me parashtesë monedhe, jo një numër JSON.
| Fusha | Kuptimi |
|---|---|
lrn | Numri i Rutimit të Vendndodhjes i përdorur për të identifikuar destinacionin e rutimit. |
ported | Treguesi nëse numri është bartur, i dhënë nga ky kërkim: zakonisht 0 ose 1. Mos e përdorni si provë pronësie ose pranueshmërie shërbimi. |
ocn | Numri i Kompanisë Operuese, kur ofrohet. |
lata | Zona Lokale e Aksesit dhe Transportit, kur ofrohet. |
rc | Qendra e tarifës, kur ofrohet. |
city, state, lec, lectype, jurisdiction, local | Detaje shtesë të vendndodhjes, operatorit ose të lidhura me origjinën, kur janë të disponueshme. Ato mund të mungojnë ose të jenë bosh. |
Mos kërkoni që çdo fushë rutimi të jetë e pranishme. Në veçanti, rezultatet për numra pa pagesë për telefonuesin mund të lënë jashtë detajet lokale të qendrës së tarifës dhe të kodit të operatorit. Një LRN e kthyer nuk është garanci në kohë reale e arritshmërisë apo test i cilësisë së telefonatës.
Përdorni kërkimet në rrjedhën tuaj të rutimit
- Validoni dhe normalizoni numrin e kërkuar përpara se ta dërgoni.
- Inspektoni statusin HTTP dhe të aplikacionit. Mbani një regjistër të numrit, kohës dhe rezultatit për diagnostikim, pasi të keni hequr të dhënat e ndjeshme.
- Përdorni vetëm fushat përkatëse për rregullin tuaj të rutimit dhe trajtojini në mënyrë të shprehur vlerat që mungojnë.
- Kufizoni riprovat pas një përgjigjeje të pasigurt. Përsëritja e një kërkimi mund të prodhojë një tarifë tjetër; kjo pikë fundore nuk ka çelës idempotence të dokumentuar.
Shihni produktin LRN dhe çmimin fiks. Shtegu publik OpenAPI përfshin një segment ANI; implementimi i vendosur LRN pranon gjithashtu kërkesën më të shkurtër pa ANI. lrninfo është një operacion i veçantë dhe nuk duhet të përdoret si zëvendësim për këtë pikë fundore.
Trajtoni gabimet dhe riprovat
- Dështim vërtetimi ose lejimi
- Kontrolloni gjendjen e aktivizimit të kredencialit API, shërbimin e lejuar dhe kufizimin e IP-së burim. Një cookie sesioni portali nuk është kredencial integrimi.
- Kredi e pamjaftueshme ose miratim i paplotësuar
- Zgjidhni problemin me bilancin e llogarisë, miratimin e dërgimit ose kërkesën për dokumente përpara se të përsërisni operacionin.
- Asnjë rezultat
- Trajtojeni inventarin bosh ose mungesën e emrit të telefonuesit si një rezultat të zakonshëm. Mos supozoni se një numër sintaksisht i vlefshëm i ka të gjitha shërbimet.
- Skadim kohe i rrjetit ose dështim shërbimi
- Përdorni riprova të kufizuara me pritje rritëse për leximet. Për një blerje, dërgim ose regjistrim, inspektoni fillimisht gjendjen e operacionit; riprovimi i një kërkese të pranuar mund të dyfishojë një veprim të faturueshëm.
Mbështetja e idempotencës i përket secilës familje API. Emergency API mbështet çelësat e riprovës; kjo nuk i bën kërkesat arbitrare v3 idempotente. Mbani vulat kohore, ID-të e kthyera dhe përgjigjet me të dhënat e ndjeshme të hequra për mbështetjen.
Vazhdoni me referencën e llogarisë suaj
Referenca pas hyrjes në llogari i filtron operacionet sipas lejeve tuaja dhe shërbimeve të aktivizuara. Përdorni hostin e saktë, llojin e kredencialeve, fushat e kërkesës dhe skemën e përgjigjes që tregon ajo. Konsolat mund të ekzekutojnë operacione reale, përfshirë blerje dhe mesazhe.