REST API -dokumentaatio
Tilin ja laskutuksen REST API:t
Lue saldo ja laskutustiedot, jotka ovat saatavilla hyväksytylle integraatiollesi.
Valitse API ja tunnistetieto yhdessä
Hyväksytyt Kehittäjät ja automaatio-, Yritys- ja Viestintäpalveluntarjoajat-tilit voivat integroida käytössä olevia palveluja. Yksittäisen kehittäjän ei tarvitse esiintyä yrityksenä. Sovellusten SMS/MMS edellyttää soveltuvaa lähetyshyväksyntää ja rekisteröintiä. Henkilöt ja perheet -palvelulla ei ole asiakkaan käytettävissä olevaa viestien lähetyksen API-rajapintaa.
| API-perhe | Perus-URL | Todennus ja tulos |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Hyväksytyt Basic-tunnistetiedot; oikeutetut provisionoidut tunnukset vain toimintoihin, jotka tukevat niitä. JSON-muotoiset status ja response. |
| Hätäpalvelun rekisteröinti | https://api.multi.tel/emergency | Hyväksytyt Basic-tunnistetiedot tai erikseen provisionoitu bearer-käyttöoikeus. JSON-muotoiset code, message ja data. |
| Portaalin REST-integraatiot | Isäntä ja toiminto on esitetty tilisi kehittäjäviitteessä | Käytä kyseisen toiminnon dokumentoitua tunnistetietoa, käyttöoikeuksia ja skeemaa. Selainistunnon pyynnöt ovat erillinen rajapinta. |
Määritä MULTITEL_API_USERNAME ja MULTITEL_API_PASSWORD palvelimesi salaisuuksien hallinnan kautta ennen esimerkkien käyttöä. Älä koskaan upota niitä julkiseen selaimen JavaScript-koodiin, URL-osoitteisiin tai versionhallintaan. Erillisiä tunnistetietoja hallitaan kohdassa API-integraation asetukset.
Ensimmäinen pyyntö: lue saldosi
Tämä lukutoiminto ei osta palvelua eikä käynnistä puhelua tai viestiä.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"Communications v3 API -rajapinta palauttaa sovellustason tuloksen JSON-rungon sisällä. Tarkista HTTP-tila ja status.code ennen response-elementin lukemista; hylätyssä pyynnössä ei välttämättä ole vastausobjektia lainkaan. Koodiarvot voivat olla merkkijonoja tai numeroita.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}Tämä on kuvitteellinen esimerkki, ei tilin saldo. Käsittele rahasummia desimaalilukuina. Säilytä palvelimen vastausviesti hylätyn pyynnön vianmäärityksessä, mutta poista tunnistetiedot.
Käytä laskutustietoja oikein
Saldovastaus sisältää nykyisen saldon, valuutan ja maksuehdot. Se ei kerro tulevan puhelun hintaa eikä muodosta täydellistä laskua. Käytä näihin kysymyksiin vastaavia hinta- ja käyttötoimintoja. Olemassa olevilla numeroilla voi olla eri sopimukset kuin tämän päivän luettelossa.
Käsittele virheet ja uudelleenyritykset
- Todennus- tai käyttöoikeusvirhe
- Tarkista API-tunnistetiedon käytössäolotila, sallittu palvelu ja lähde-IP-rajoitus. Portaalin istuntoeväste ei ole integraation tunnistetieto.
- Riittämätön saldo tai puuttuva hyväksyntä
- Selvitä tilin saldo, lähetyshyväksyntä tai asiakirjavaatimus ennen toiminnon toistamista.
- Ei tulosta
- Käsittele tyhjää varastoa tai puuttuvaa soittajan nimeä tavallisena tuloksena. Älä oleta, että syntaktisesti kelvollisella numerolla on kaikki palvelut.
- Verkon aikakatkaisu tai palveluvirhe
- Käytä lukutoiminnoissa rajoitettuja uudelleenyrityksiä viiveen pidennyksellä. Tarkista oston, lähetyksen tai rekisteröinnin yhteydessä ensin toiminnon tila; hyväksytyn pyynnön uudelleenyritys voi monistaa laskutettavan toiminnon.
Idempotenssituki määräytyy API-perhekohtaisesti. Emergency API tukee uudelleenyritysavaimia; se ei tee mielivaltaisista v3-pyynnöistä idempotentteja. Säilytä aikaleimat, palautetut tunnukset ja sensuroidut vastaukset tukea varten.
Jatka tilisi viiteaineistoon
Kirjautuneen käyttäjän viiteaineisto näyttää toiminnot käyttöoikeuksien ja käytössä olevien palvelujen mukaan. Käytä siinä ilmoitettua tarkkaa isäntää, tunnistetietotyyppiä, pyyntökenttiä ja vastausskeemaa. Konsolit voivat suorittaa todellisia toimintoja, myös ostoja ja viestien lähetyksiä.