Home > Megoldások partnereinknek > API használata

API használata

Nemrégiben üzemeltetésbe helyeztük a vadonatúj REST API-t. A pontos leírást és minden egyéb információt megtalál a https://rest.websupport.sk/docs/index oldalon.

Az eredeti API-t idővel lecseréljük a REST API-ra, ezért a régi verzió használatát nem ajánljuk!



Az eredeti API:

A Webonic (Websupport) API komunikációhoz nem szükséges új programot írni a kezdetektől. Programozóink elkészítettek egy PHP könyvtárat, mintapéldákkal a használathoz. Ezenfelül az API komunikáció alap funkciói letesztelhetők a böngésző segítségével.

Az API lekérdezések a  https://api.websupport.sk URL címen elérhetők. Az API komunikációt a REST alapján kell megvalósítani, azaz helyesen kell beállítani a lekérdezés módszerét. A Webonic (Websupport) API jelenleg a GET és a PUT lekérdezéseket fogadja el. Az URL címhez hozzá kell adni azokat az adatokat, amik konkretizálják az API kulcsot (apikey), az API lekérdezést (resource) és a paramétereket.

A teljes URL cím vázlata:

https://api.websupport.sk/<apikey>/<resource>[/resourceParam1[/resourceValue1[/serviceParam1[/<serviceValue1...]]]]

A kiválasztott resource általában kiegészítő paramétereket kér, hogy pontosan tudja milyen API lekérdezést kell elvégeznie. A resource paraméterek után általában a konkrét szolgáltatás paraméterei következnek. A következő mintapéldában lekérdezzük a price (az ár lekérdezéséhez) resource-t. A konkrét szolgáltatást a service paraméter segítségével adjuk meg a resource-ban a custom (Custom hoszting) érték megadásával. Mivel ezen szolgáltatás ára a szolgáltatás további paramétereitől függ, adjuk hozzá az URL címhez rögtön a resouce után a service paramétert.

Példa a teljes URL címre:

https://api.websupport.sk/mojapikluc123/price/service/custom/limit_web/100/limit_mail/3/limit_database/5

A szerver JSON láncolattal válaszol: (a böngészőben való megjelenítéshez a  JSONovich bővítés telepítése használatos a Firefox-ban)

{
    pk: "3"

    attributes: {
        service_id: "3"
        name: "Custom hosting"
        domain_name: null
        expiration_date: 1298579791
        price: 1.9
        limit_web: "100"
        limit_mail: "3"
        limit_database: "5"
        period: "1"
        period_length: "2629744"
    }

    errors: [ ]
}

Észrevehetjük, hogy a válasz a következőket tartalmazza:

  • a szolgáltatás egyedi ID száma a Webonic rendszerében

  • a szolgáltatás részletei az „attributes” mezőben. A választott paraméterek ebben a mezőben módosíthatók az alapértelmezett értékről a service paraméterek segítségével az URL címben, ahogyan azt a fenti példában szemléltettünk.

  •  Errors mező, ami bármilyen hiba esetén tartalmazza a hiba értelmezhető leírását.


API kulcs

Minden regisztrált felhasználónak lehetősége nyílik a felhasználói fiókon belül egy egyedi API kulcs generáláshoz. Ez egy rövid láncolat, ami betűket és számjegyeket tartalmaz. Ezt a kulcsot senkinek ne adja tovább és az oldal látható forráskódjába se építse be. Ha mégis kiszivárogna, azonnal generáljon egy újat. Az API kulcsot ezután az URL címben használja a Webonic API komunikációhoz a fenn szemléltetett példák alapján. A kulcsnak minden API lekérdezésben szerepelnie kell.

Az API kulcs generálása:

  1. Jelentkezzen be a Webadmin felületre

  2. Válassza a Settings (Beállítások) menüpontot.

  3. Az API kulcsot a képernyő alján, az  Api key management részben kérheti.