REST API dokumentáció
Fiók- és számlázási REST API-k
Olvassa le az egyenleget és a jóváhagyott integrációja számára elérhető számlázási információkat.
Az API-t és a hitelesítő adatot együtt válassza ki
A jóváhagyott Fejlesztők és automatizálás, Üzleti és Kommunikációs szolgáltatók profilú fiókok integrálhatják az engedélyezett szolgáltatásokat. Egy magánfejlesztőnek nem kell cégnek kiadnia magát. Az alkalmazásból küldött SMS/MMS-hez a megfelelő küldési jóváhagyás és regisztráció szükséges. A Magánszemélyek és családok szolgáltatáshoz nem tartozik ügyfelek számára elérhető üzenetküldő API.
| API-család | Alap-URL | Hitelesítés és eredmény |
|---|---|---|
| Kommunikációs v3 | https://api.multitel.net/v3 | Jóváhagyott Basic hitelesítő adatok; jogosult, kiosztott tokenek csak az azokat támogató műveleteknél. JSON status és response. |
| Segélyhívási regisztráció | https://api.multi.tel/emergency | Jóváhagyott Basic hitelesítő adatok vagy kifejezetten kiosztott bearer hozzáférés. JSON code, message és data. |
| Portál REST-integrációk | A fiókja fejlesztői referenciájában látható gazdagép és művelet | Használja az adott művelet dokumentált hitelesítő adatát, hatóköreit és sémáját. A böngészős munkamenetkérések külön felületet jelentenek. |
A példák használata előtt állítsa be az MULTITEL_API_USERNAME és az MULTITEL_API_PASSWORD értékét a szervere titokkezelő konfigurációjában. Soha ne helyezze ezeket nyilvános böngészős JavaScriptbe, URL-ekbe vagy a verziókezelőbe. A külön hitelesítő adatokat az API-integráció beállításaiban kezelheti.
Első kérés: az egyenleg lekérdezése
Ez a lekérdezés nem vásárol szolgáltatást, és nem indít hívást vagy üzenetet.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"A kommunikációs v3 API a JSON-törzsben adja vissza az alkalmazásszintű eredményt. A response olvasása előtt ellenőrizze a HTTP-állapotot és a status.code értékét; elutasított kérés esetén a válaszobjektum hiányozhat. A kódértékek karakterláncok vagy számok is lehetnek.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}Ez egy kitalált példa, nem egy fiók egyenlege. A pénzösszegeket tizedes törtként kezelje. Egy elutasított kérés diagnosztizálásakor őrizze meg a szerver válaszüzenetét, a hitelesítő adatok eltávolításával.
A számlázási adatok helyes használata
Az egyenlegválasz tartalmazza az aktuális egyenleget, a pénznemet és a fizetési feltételeket. Nem adja meg egy jövőbeli hívás költségét, és nem teljes számla. Ezekhez használja a megfelelő díjszabási és használati műveleteket. A meglévő számok tarifacsomagja eltérhet a mai katalógusétól.
Hibák és újrapróbálkozások kezelése
- Hitelesítési vagy jogosultsági hiba
- Ellenőrizze az API-hitelesítő adat engedélyezett állapotát, az engedélyezett szolgáltatást és a forrás-IP-korlátozást. A portál munkamenet-sütije nem integrációs hitelesítő adat.
- Elégtelen egyenleg vagy hiányzó jóváhagyás
- A művelet megismétlése előtt rendezze a fiók egyenlegét, a küldési jóváhagyást vagy a dokumentumkövetelményt.
- Nincs eredmény
- Az üres készletet vagy a hiányzó hívónevet kezelje szokásos kimenetelként. Ne feltételezze, hogy egy szintaktikailag érvényes számhoz minden szolgáltatás elérhető.
- Hálózati időtúllépés vagy szolgáltatáshiba
- Olvasási műveleteknél korlátozza az újrapróbálkozások számát, és alkalmazzon várakozást a próbálkozások között (backoff). Vásárlás, küldés vagy regisztráció esetén először vizsgálja meg a művelet állapotát; egy már elfogadott kérés megismétlése megkettőzheti a díjköteles műveletet.
Az idempotencia támogatása API-családonként eltérő. Az Emergency API támogatja az újrapróbálási kulcsokat, de ettől a tetszőleges v3-kérések még nem lesznek idempotensek. Az ügyfélszolgálat számára őrizze meg az időbélyegeket, a visszaadott azonosítókat és a kitakart válaszokat.
Folytassa a fiókjához tartozó referenciával
A bejelentkezett állapotban elérhető referencia a műveleteket a jogosultságai és az engedélyezett szolgáltatások szerint szűri. Használja annak pontos hosztját, hitelesítő adat típusát, kérésmezőit és válaszsémáját. A konzolok éles műveleteket is végrehajthatnak, beleértve a vásárlásokat és az üzenetküldést.