Přeskočit na hlavní obsah

Ověření

Pro přístup k rozhraní REST API můžete použít ověření Microsoft Entra ID (ME-ID) nebo základní ověření.

Oprávnění pro operace rozhraní REST API se řídí oprávněními přistupujícího uživatele v systému Alvao.

Microsoft Entra ID​

Nejprve v Alvao nastavte Microsoft Entra ID uživatelskou autentizaci.

Aplikace s přihlášeným uživatelem (jménem uživatele)​

Aby bylo možné přistupovat k rozhraní REST API z interaktivní aplikace, do které jsou uživatelé přihlášeni (např. webové nebo mobilní aplikace), musí být účty těchto uživatelů importovány do systému Alvao. Pro ověření přístupu proveďte následující:

  1. Ověřte uživatele pomocí příslušného toku k aplikaci Microsoft Entra ID, kterou jste přidělili Alvao.
  2. Předejte získaný token k REST API v hlavičce HTTP Autorizace: na doručitele <token>.

Neinteraktivní aplikace​

Pro přístup z aplikací nebo skriptů, které nepracují s přihlášeným uživatelem (např. integrační skript), postupujte následovně:

  1. V aplikaci Microsoft Entra ID přidružené k aplikaci Alvao v části registrace aplikace přidejte volitelný token ( viz více ):
    1. V aplikaci přejděte do konfigurace Tokenu.
    2. Klikněte na Přidat volitelnou deklaraci identity..
    3. Vyberte Přístup v typu Tokenu a idtyp nárokovat a potvrdit tlačítkem Přidat
  2. V aplikaci Microsoft Entra ID zaregistrujte novou aplikaci, která bude komunikovat s rozhraním REST API.
  3. Vytvořte nového uživatele v Správa - Uživatelé. Zapněte možnost Aplikační účet, vyberte typ Aplikace Microsoft Entra ID a přidejte údaje o aplikaci zaregistrované v předchozím kroku. Poté přiřaďte účtu potřebná oprávnění v systému Alvao.
  4. Získejte token pro aplikaci ze kroku 2 pomocí tokenu klientských přihlašovacích údajů (nastavte jako rozsah: <Client ID Alvao application> /.default) a předáte jej REST API v HTTP záhlaví Authorization: Bearer <token>.

Základní ověření​

Základní ověření slouží pouze pro přístup z neinteraktivních aplikací.

  1. Vytvořte nového uživatele v Správa - Uživatelé. Zapněte možnost Aplikační účet a vyberte typ Ostatní aplikace. Poté nastavte heslo účtu a přiřaďte potřebná oprávnění v Alvao.
  2. Předejte uživatelské jméno a heslo rozhraní REST API prostřednictvím standardní hlavičky basic authentication.
Tip

Doporučujeme používat bezpečnější způsob ověřování pomocí Microsoft Entra ID.