Přístup k plusPortal API

Změníl(a) - Vladimír Koutný

Přístup na stránku API.ashx je ověřován pomocí Basic authentication. V aplikaci plusPortal proto musí v seznamu uživatelů existovat uživatel, který bude mít přiřazeno právo Uživatel API z oblasti Osobní možnosti sady přístupových práv.

Program, který žádá z plusPortalu data přes rozhraní API, se identifikuje prostřednictvím přihlašovacích údajů tohoto uživatele. Pro používání API doporučujeme mít výhradně speciálního uživatele, který bude používán pouze pro tento účel.

Funkce API.ashx nemá pevně definované parametry (vstupní body) pro získávání konkrétních sad dat. Místo toho je lze v plusPortalu uživatelsky definovat podle toho, jaká data do jiných programů potřebujeme získat.

Pro vytváření těchto API funkcí musí být zakoupena licence pro submodul API (mod_01_API) a uživatel, který je bude vytvářet, musí mít přidělena práva: Uživatel API a Vytváření dotazů z oblasti Osobní možnosti a právo Funkce API z oblasti Nastavení. Tato práva jsou předdefinována v sadě Administrátor API. 

Požadovaná data lze získat zavoláním API funkce, kde v parametru function je uveden název požadované datové sady (která byla před tím na straně aplikace plusPortal nastavena).

Příklad:

GET

https://vas_pp_server/mod_01/API.ashx?function=employees

Testování volání API je možné např. pomocí programu Postman (https://www.postman.com/), který obsahuje veškeré potřebné funkce.

Požadovaná data budou vrácena v odpovědi protokolu http ve struktuře JSON.

Jak hodnotíte článek?