Service account kezelés

Alapok

A Service account-okat a rendszer által biztosított API végpontok eléréséhez használhatjuk. Minden service accountnak van egy azonosítója, amit login névként kell használni, és egy jelszava. Ezeket használva az API végpontokat hagyományos HTTP authentikációs header-el lehet meghívni.

A service account-okat a Config / Service Accounts menü alatt lehet kezelni: Itt egy lista látható az aktív account-okkal: Egy konkrét account jelszavát a Password gombra kattintva lehet lekérni.

Új account létrehozása

Új account-ot az Add gombra kattintva lehet generálni. Mivel minden account-al el lehet érni minden API végpontot, így nem érdemes egyszerre egynél több aktív account-ot kezelni.

Account törlése

Amennyiben egy account hozzáférését bármilyen okból vissza kell vonni (például a jelszava publikussá válik), meg kell szüntetni az adott account-ot a Revoke gombbal, egy új account-ot generálni, és annak az adatait beállítani az API kliensbe.

API kapcsolat tesztelése

Az API a https://app.forwardhub.com/ domain-en érhető el. A kapcsolatot a POST https://app.forwardhub.com/whoami végponton lehet tesztelni, a request body-ban nem kell küldeni semmilyen adatot, azonban a HTTP Authentikációs adatokat a kiválasztott service account adataival kell feltölteni.

Sikeres hívás és aktív service account esetén HTTP 201 választ ad a végpont, illetve visszaadja a service account adatait:

Nem létező, vagy inaktív service account, illetve hibás jelszó esetén HTTP 401 választ ad, és nem ad vissza részleteket, hogy pontosan miért nem sikerült csatlakozni.