Rest API dokumentáció

SMS küldő Rest API dokumentáció

A REST API (Representational State Transfer) egy modern, könnyen használható webes szolgáltatás, amely lehetővé teszi az egyszerű és gyors kommunikációt rendszerek között. A REST API JSON vagy XML alapú adatcserét használ, amely sok fejlesztő számára ismerős és könnyen feldolgozható, így egyszerűen integrálható bármilyen fejlesztői környezetbe. A REST API-nk rugalmas és jól skálázható megoldást kínál az SMS küldési és menedzsment funkciókhoz.

A REST API-t HTTP metódusokon keresztül érheti el, mint például a POST, GET és DELETE. A hitelesítési folyamat a connect függvény segítségével történik, ahol az API-t használó felhasználó token alapú hitelesítést kap. Ezt követően az API-n keresztül le lehet kérdezni az SMS küldési krediteket (getCreditNumber), lekérhetők a havi statisztikák (getMonthlyStat), vagy éppen elindítható egy SMS küldés a sendSMS függvénnyel.

A REST API egyszerűsége és gyorsasága miatt kiváló választás a fejlesztők számára, különösen azoknak, akik rugalmas, webes megoldásokban gondolkodnak. Ideális választás lehet különféle platformokhoz, mobilalkalmazásokhoz vagy más webes rendszerekhez történő integrációhoz. A REST API-nk segítségével a vállalkozások hatékonyan kezelhetik SMS kampányaikat, értesítéseiket, és valós időben követhetik a küldött üzenetek státuszát, mindezt gyors és egyszerű módon.

A simpleSMS REST API

  • végpontja a https://api.simplesms.hu/rest/SMSapi/ url-en belül érhető el.
  • Rest api hívások postmanben itt tölthetők le 

1. Kapcsolódás: connect (https://api.simplesms.hu/rest/SMSapi/connect)

Minden további REST API metódus hívásához szükséges a kapcsolódás, ha nincs kapcsolódás vagy sikertelen volt a további kérések hibaüzenettel kerülnek elutasításra.

Az itt kapott access_tokent bearer tokenként használva lehet a további metódusokat elérni.

Paraméterek: a paramétereket a hívás POSTként várja 

  • username: a simplesms portálon az API hozzáféréseknél megadott felhasználónév
  • password: a simplesms portálon az API hozzáféréseknél megadott jelszó
  • domain: a simplesms portálon az API hozzáféréseknél megadott jelszó

Visszatérési érték:

  • mindig egy tömböt adunk vissza
  • sikeres üzenet esetén visszaadott értékek:
    • access_token: ezt szükséges használni a további metódusok hívásánál
    • expires_in: a token lejáratának ideje
  • hibás válasz esetén hibaüzenetet ad vissza a végpont

2. SMS küldés: sendSMS

Végpont: https://api.simplesms.hu/rest/SMSapi/sendSMS

Paraméterek: a paramétereket ez a hívás is POSTként várja

  • country_code: az ország hívószáma (pl Magyarország 36)

  • area_code: a szolgáltató kódja (pl Telekom 30, Yettel 20, Vodafone 70, Digi 50...)

  • number: a telefonszám további része (pl 1234567)

  • message: a kiküldésre szánt SMS tartalma

Visszatérési érték:

  • sikeres üzenet esetén a response értékben adjuk vissza az sms belső azonosítóját amivel később a státuszok vagy hisztorikus információk lekérhetők
  • hibás válasz esetén a hibaüzenetet ad vissza a végpont

3. Egyenleg lekérdezése: getCreditNumber

Végpont: https://api.simplesms.hu/rest/SMSapi/getCreditNumber

Paraméterek nincsennek

Visszatérési érték:

  • sikeres érték esetén a visszakapott tömbben reponse mező értéke tartalmazza az elérhető egyenleget
  • hiba esetén hibaüzenetet ad vissza az API végpont

4. Havi statisztika lekérdezése: getMonthlyStat

Végpont: https://api.simplesms.hu/rest/SMSapi/getMonthlyStat

Paraméterek nincsennek

Visszatérési érték:

  • sikeres érték esetén a visszakpott tömbben a havi statisztika egy tömbben kerül visszaadásra ÉÉÉÉ-HH bontásban külön a belföldi és külföldi sms számokkal.
  • hiba esetén hibaüzenetet ad vissza az API végpont

5. SMS státusz: getStatus

Végppont: https://api.simplesms.hu/rest/SMSapi/getStatus

A rendszer lehetőséget nyújt az aktuális státusz lekérdezésére

Paraméterek: a paraméteret POST-ként várja az api hívás

  • sms_id: a sendSMS által visszaadott SMS belső azonosítója

Visszatérési érték:

  • sikeres kérés esetén a választ a visszaadott tömb reponse mezője tartalmazza, itt minden információ megtalálható az SMSsel kapcsolatban
    • küldéskor megadott adatok
    • létrehozás ideje
    • küldési státusz
    • utolsó státusz változás ideje
  • hiba esetén a hibaüzenetet adja vissz az api

6. SMS státusz történet: getHístory()

Végpont: https://api.simplesms.hu/rest/SMSapi/getHistory

A rendszer lehetőséget nyújt az SMS státusz változásainak lekérdezésére

Paraméterek: a paramétert POST-ként várja az api hívás

  • sms_id: a sendSMS által visszaadott SMS belső azonosítója

Visszatérési érték:

  • sikeres kérés esetén a választ a visszaadott tömb reponse mezője tartalmazza, itt minden információ megtalálható az SMSsel kapcsolatban
    • utolsó státusz adatok (kód, üzenet, dátum, egyes típusok esetén megjegyzés)
  • hiba esetén a hibaüzenet  adja vissz az api

További részletekért és az integrációk beállításához kérjük, tekintse át az API dokumentáció teljes tartalmát, vagy lépjen kapcsolatba velünk, ha kérdése van!