REST API dokumentācija
Konta un norēķinu REST API
Nolasiet konta atlikumu un norēķinu informāciju, kas pieejama jūsu apstiprinātajai integrācijai.
Izvēlieties API un akreditācijas datus kopā
Apstiprināti konti kategorijās Izstrādātājiem un automatizācijai, Bizness un Sakaru pakalpojumu sniedzēji var integrēt iespējotus pakalpojumus. Individuālam izstrādātājam nav jāizliekas par uzņēmumu. Lietojumprogrammu SMS/MMS nepieciešams atbilstošs sūtīšanas apstiprinājums un reģistrācija. Pakalpojumam Privātpersonām un ģimenēm nav klientiem pieejama API ziņojumu sūtīšanas sākšanai.
| API saime | Bāzes URL | Autentifikācija un rezultāts |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Apstiprināti Basic akreditācijas dati; atbilstoši nodrošināti pilnvarojumi tikai darbībām, kas tos atbalsta. JSON status un response. |
| Reģistrācija ārkārtas zvanu pakalpojumam | https://api.multi.tel/emergency | Apstiprināti Basic akreditācijas dati vai īpaši nodrošināta bearer piekļuve. JSON code, message un data. |
| Portāla REST integrācijas | Resursdators un darbība ir norādīta jūsu konta izstrādātāju uzziņā | Izmantojiet šīs darbības dokumentētos akreditācijas datus, tvērumus un shēmu. Pārlūkprogrammas sesijas pieprasījumi ir atsevišķa saskarne. |
Pirms piemēru izmantošanas iestatiet MULTITEL_API_USERNAME un MULTITEL_API_PASSWORD, izmantojot sava servera slepeno konfigurāciju. Nekad neieguliet tos publiskā pārlūkprogrammas JavaScript kodā, URL vai pirmkoda kontrolē. Speciālie akreditācijas dati tiek pārvaldīti sadaļā API integrācijas iestatījumi.
Pirmais pieprasījums: nolasiet savu bilanci
Šī nolasīšana neiegādājas pakalpojumu un neierosina zvanu vai ziņojumu.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"Komunikāciju v3 API JSON pamattekstā atgriež lietojumprogrammas rezultātu. Pārbaudiet HTTP statusu un status.code pirms response lasīšanas; noraidītam pieprasījumam var nebūt atbildes objekta. Kodu vērtības var būt virknes vai skaitļi.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}Šis ir izdomāts piemērs, nevis konta bilance. Uzskatiet naudas vērtības par decimālām summām. Diagnosticējot noraidītu pieprasījumu, saglabājiet servera atbildes ziņojumu, izņemot akreditācijas datus.
Izmantojiet norēķinu datus pareizi
Bilances atbilde satur pašreizējo bilanci, valūtu un maksājumu noteikumus. Tā nenorāda nākotnes zvana izmaksas vai pilnu rēķinu. Šiem jautājumiem izmantojiet atbilstošās tarifa un lietojuma darbības. Esošiem numuriem var būt citādi plāni nekā šodienas katalogā.
Apstrādājiet kļūdas un atkārtojumus
- Autentifikācijas vai atļaujas kļūme
- Pārbaudiet API akreditācijas datu iespējoto stāvokli, atļauto pakalpojumu un avota IP ierobežojumu. Portāla sesijas sīkfails nav integrācijas akreditācijas dati.
- Nepietiekams kredīts vai neizpildīts apstiprinājums
- Pirms darbības atkārtošanas sakārtojiet konta bilanci, sūtīšanas apstiprinājumu vai dokumentu prasību.
- Nav rezultāta
- Tukšu krājumu vai trūkstošu zvanītāja vārdu uzskatiet par parastu iznākumu. Nepieņemiet, ka sintaktiski derīgam numuram ir visi pakalpojumi.
- Tīkla noildze vai pakalpojuma kļūme
- Lasīšanai izmantojiet ierobežotus atkārtojumus ar aizkavi. Pirkumam, sūtīšanai vai reģistrācijai vispirms pārbaudiet darbības stāvokli; pieņemta pieprasījuma atkārtošana var dublēt apmaksājamu darbību.
Idempotences atbalsts ir atkarīgs no API saimes. Emergency API atbalsta atkārtošanas atslēgas; tas nepadara patvaļīgus v3 pieprasījumus par idempotentiem. Atbalstam saglabājiet laikspiedolus, atgrieztos ID un atbildes, no kurām izņemti sensitīvie dati.
Turpiniet ar sava konta atsauci
Pēc pierakstīšanās pieejamā dokumentācija filtrē darbības atbilstoši jūsu atļaujām un iespējotajiem pakalpojumiem. Izmantojiet tajā norādīto precīzo resursdatoru, akreditācijas datu veidu, pieprasījuma laukus un atbildes shēmu. Konsoles var veikt reālas darbības, tostarp pirkumus un ziņojumu sūtīšanu.