Dokumentáció fejlesztői és tesztelési célú API-integrációhoz

A sandbox környezet használata különösen fontos akkor, amikor egy külső rendszer az IMA API-n keresztül adatokat kérdez le, tölt be vagy módosít. A tesztelés így elkülönített adatbázison történhet, az éles könyvelési adatok veszélyeztetése nélkül.

1. Miért van szükség sandbox környezetre?

Az IMA szoftveres infrastruktúrája kiemelt mértékben támogatja az API-n keresztüli kommunikációt. API-n keresztül lehetőség van adatok kinyerésére, valamint adatok IMA rendszerébe történő betöltésére vagy módosítására is.

Mivel az API-műveletek közvetlen hatással lehetnek a könyvelési adatokra, a külső rendszerek üzemszerű bekötése előtt javasolt a megoldások tesztelése nem éles adatbázison.

2. Az API-hívásokhoz szükséges azonosítók

A kapcsolat felépítéséhez az alábbi adatokra lesz szükség:

• API-API kulcs, más néven API működtető kulcs
• IMA felhasználói név
• Cégadatbázis-azonosító

3. A tesztelési / fejlesztési környezet létrehozása

3.1. API működtető kulcs beszerzése

Az API működtetéséhez szükséges API-API kulcsot az IMA licenc tulajdonosa kapja meg a licenc aktiválásakor. Ezt az értéket kell majd használni az API-kapcsolat felépítéséhez.

3.2. Teszt adatbázis létrehozása az IMA kliensben

A teszt adatbázis célja, hogy a fejlesztés és a tesztelés során végzett műveletek ne okozzanak problémát az éles adatokban.

Hol érhető el:
IMA kliens / Cégek kiválasztása / Új ikon

1. ábra - Új teszt cég létrehozása az IMA kliensben

1. A felbukkanó ablakban adja meg a cég nevét.
2. Jelölje be a „Teszt cég” opciót.
3. Mentse a beállításokat, majd várja meg az új cég létrehozását. Ez általában néhány percet vesz igénybe.

Az API használatához szükséges cégadatbázis-azonosító a céglistában, a táblázat első oszlopában található.

3.3. Sandbox, vagyis teszt felhasználó létrehozása

Az API-hívások végrehajtásához külön IMA felhasználóra van szükség. Javasolt dedikált sandbox felhasználót létrehozni, amely kizárólag a teszt adatbázishoz kap jogosultságot.

Hol érhető el:
IMA kliens / Program adminisztráció / Felhasználók

2. ábra - Felhasználók menüpont megnyitása

Kattintson az Új ikonra.

A beállítások szekcióban adja meg az alapadatokat.

3. ábra - Sandbox felhasználó alapadatainak megadása

Lépjen át a Speciális jogok 1 szekcióba, jelölje be az API felhasználó opciót, majd mentse az adatokat az OK gombbal.

4. ábra - API felhasználó jogosultság beállítása

Mentés után a Karton gombbal nyissa meg újra a felvitt felhasználói kartont. 

Válassza ki az Adatbázis jogok szekciót. A Van joga oszlopban kattintson arra az adatbázisra, amelyet a tesztrendszer használatához létrehozott. A kiválasztott adatbázisnál egy kis ikon jelzi az aktív jogosultságot.

5. ábra - Adatbázis-jogosultság hozzárendelése a sandbox felhasználóhoz

Az így létrehozott felhasználóval megkezdhető az API-végpontok tesztelése és beüzemelése.

4. Üzembe helyezés és további információk

Az API üzemszerű használatának lépései az alábbi blogcikkben találhatók: IMA API kapcsolat használatbavétele

Hasznos információs források:

• IMA API témájú blogcikkek
• Swagger dokumentáció 1
• Swagger dokumentáció 2

5. Ellenőrző lista átadás előtt

• Az API-API kulcs rendelkezésre áll.
• A teszt cégadatbázis létrejött az IMA kliensben.
• A cégadatbázis-azonosító rögzítésre került.
• A sandbox felhasználó létrejött.
• A sandbox felhasználónál be van állítva az API felhasználó jogosultság.
• A sandbox felhasználó csak a teszt adatbázishoz kapott hozzáférést.
• A fejlesztéshez javasolt API-végpont került kiválasztásra.