Dokumentacioni i REST API
API REST për llogarinë dhe faturimin
Lexoni bilancin dhe informacionin e faturimit që i ofrohet integrimit tuaj të miratuar.
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ërkesa e parë: lexoni bilancin tuaj
Ky lexim nuk blen një shërbim dhe as nuk origjinon një telefonatë apo mesazh.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"API-ja e komunikimeve v3 kthen një rezultat aplikacioni brenda trupit JSON. Kontrolloni statusin HTTP dhe status.code përpara se të lexoni response; një kërkesë e refuzuar mund të mos ketë objekt përgjigjeje. Vlerat e kodit mund të jenë vargje ose numra.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}Ky është një shembull imagjinar, jo një bilanc llogarie. Trajtojini vlerat monetare si shuma dhjetore. Ruajeni mesazhin e përgjigjes së serverit kur diagnostikoni një kërkesë të refuzuar, me kredencialet të hequra.
Përdorni saktë të dhënat e faturimit
Përgjigjja e bilancit përmban bilancin aktual, monedhën dhe kushtet e pagesës. Ajo nuk jep koston e një telefonate të ardhshme apo një faturë të plotë. Përdorni operacionet përkatëse të tarifave dhe të përdorimit për këto pyetje. Numrat ekzistues mund të kenë plane të ndryshme nga katalogu i sotëm.
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.