REST API dokumentatsioon
Konto ja arveldamise REST API-d
Lugege saldot ja arveldusteavet, mis on teie heakskiidetud integratsioonile kättesaadav.
Valige API ja autentimisandmed koos
Profiilide Arendajad ja automatiseerimine, Äri ning Side teenusepakkujad heakskiidetud kontod saavad integreerida lubatud teenuseid. Üksikarendajal ei ole vaja teeselda, et ta on ettevõte. Rakenduse SMS/MMS nõuab asjakohast saatmisluba ja registreerimist. Profiili Eraisikud ja pered teenusel puudub kliendile kättesaadav sõnumite saatmise API.
| API-perekond | Baas-URL | Autentimine ja tulemus |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Heakskiidetud Basic-autentimisandmed; sobivad väljastatud tokenid ainult toimingute puhul, mis neid toetavad. JSON status ja response. |
| Hädaabikõnede registreerimine | https://api.multi.tel/emergency | Heakskiidetud Basic-autentimisandmed või spetsiaalselt seadistatud bearer-juurdepääs. JSON code, message ja data. |
| Portaali REST-integratsioonid | Host ja toiming on näidatud teie konto arendajate teatmeteoses | Kasutage selle toimingu dokumenteeritud autentimisandmeid, õiguste ulatusi ja skeemi. Brauseri seansipäringud kasutavad eraldi liidest. |
Seadistage enne näidete kasutamist MULTITEL_API_USERNAME ja MULTITEL_API_PASSWORD oma serveri saladuste konfiguratsiooni kaudu. Ärge kunagi manustage neid avalikku brauseri JavaScripti, URL-idesse ega lähtekoodi haldusse. Eraldi autentimisandmeid hallatakse jaotises API integratsiooni seaded.
Esimene päring: lugege oma saldot
See lugemine ei osta teenust ega algata kõnet või sõnumit.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"Communications v3 API tagastab JSON-kehas rakenduse tulemuse. Kontrollige HTTP-olekut ja status.code enne response lugemist; tagasilükatud päringul võib vastuseobjekt puududa. Koodi väärtused võivad olla stringid või numbrid.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}See on väljamõeldud näide, mitte konto saldo. Käsitlege rahalisi väärtusi kümnendarvudena. Tagasilükatud päringu diagnoosimisel säilitage serveri vastusesõnum, eemaldades autentimisandmed.
Kasutage arveldusandmeid õigesti
Saldovastus sisaldab praegust saldot, valuutat ja maksetingimusi. See ei anna tulevase kõne maksumust ega täielikku arvet. Nende küsimuste jaoks kasutage vastavaid tariifi- ja kasutusetoiminguid. Olemasolevatel numbritel võivad olla tänasest kataloogist erinevad plaanid.
Vigade ja korduskatsete käsitlemine
- Autentimise või loa tõrge
- Kontrollige, kas API autentimisandmed on lubatud, millisele teenusele need juurdepääsu annavad ja milline lähte-IP piirang kehtib. Portaali seansiküpsis ei ole integratsiooni autentimisandmed.
- Ebapiisav krediit või nõutava heakskiidu puudumine
- Enne toimingu kordamist lahendage konto saldo, saatmisloa või dokumendinõudega seotud probleem.
- Tulemus puudub
- Käsitlege tühja laoseisu või puuduvat helistaja nime tavapärase tulemusena. Ärge eeldage, et süntaktiliselt kehtival numbril on kõik teenused.
- Võrgu ajalõpp või teenuse tõrge
- Kasutage lugemistoimingute puhul piiratud korduskatseid koos kasvava ooteajaga. Ostu, saatmise või registreerimise puhul kontrollige esmalt toimingu olekut; vastuvõetud päringu kordamine võib arveldatavat toimingut dubleerida.
Idempotentsuse tugi on API-perekonniti erinev. Emergency API toetab korduskatsete võtmeid; see ei muuda suvalisi v3 päringuid idempotentseks. Hoidke toe jaoks alles ajatemplid, tagastatud ID-d ja vastused, millest on tundlikud andmed eemaldatud.
Jätkake oma konto dokumentatsiooniga
Pärast sisselogimist kuvatav dokumentatsioon filtreerib toimingud teie õiguste ja lubatud teenuste järgi. Kasutage selles näidatud täpset hosti, autentimisandmete tüüpi, päringuvälju ja vastuseskeemi. Konsoolid võivad teha tegelikke toiminguid, sealhulgas oste ja sõnumite saatmist.