Tento článek vysvětluje, jak nastavit API identity ve FM.
Použití API identity umožňuje detailní přístup k Dalux FM API s využitím stávajících uživatelských rolí a logiky regionů. To umožňuje omezení přístupu k API pouze na nezbytná data.
Více informací
Pro více informací o Dalux API si přečtěte tento článek: Dalux API.
Jak nastavit API identity
Technické informace
API identity lze použít pro přístup k Dalux FM API od verze 2.0.0 a novější.
API identity mohou vytvářet a spravovat pouze správci v instanci FM.
API identity nemůže používat e-mail, který je již spojen s registrovaným nebo pozvaným uživatelem v Dalux FM. Podobně nelze e-mail pro API identitu použít pro uživatele Dalux FM.
K vytvoření API identity přejděte na:
Nastavení
Integrace
'API identity':
Chcete-li vytvořit novou identitu API, klikněte Přidat.
-
Typ identity - Máte dvě možnosti
- Obecná - Přímý přístup k datům v instanci FM
- Společnost - Přístup externího dodavatele k datům, jak je nastaven ve firemním nastavení
- Jméno - Jméno identity API (lze změnit později)
- Email - Email používaný pro komunikaci týkající se služeb Dalux API a použití identity API (nelze změnit po vytvoření identity API)
- Správce - Přepisuje oprávnění jakékoli uživatelské role a dává přístup ke všem datům. Pro typ identity 'Společnost' poskytuje přístup správce společnosti.
- Popis - Volitelný popis pro API identitu, který vám a dalším pomůže později
Po vyplnění požadovaných informací, po přečtení a přijetí podmínek, klikněte na 'Vytvořit' pro pokračování v nastavení API identity.
Poznámka
API klíče nejsou generovány, dokud je nepřidáte do API identity později v procesu.
Nyní můžete k API identitě přiřadit uživatelské role a regiony. Ty určují, která data jsou dostupná přes API. Například nemůžete přistupovat k datům pracovních příkazů, pokud přiřazené uživatelské role nemají přístup k pracovním příkazům.
Pokud má API identita administrátorská oprávnění, přepisuje jakákoli oprávnění v uživatelských rolích a dává přístup ke všem datům.
Pro přidání uživatelských rolí a regionů k API identitě, klikněte na 'Přidat' v oblasti uživatelských rolí.
Můžete přidat uživatelské role samotné, nebo také specifikovat region pro uživatelskou roli.
Jakmile přidáte své uživatelské role, můžete začít vytvářet API klíče. Pro vytvoření API klíčů pro identitu API klikněte na 'Přidat' v oblasti API klíčů. Při vytváření API klíče musíte specifikovat čas vypršení platnosti klíče.
Po kliknutí na 'Přidat' bude API klíč vygenerován.
Zkopírujte klíč a distribuujte ho dle podmínek. API identita může nyní používat svůj API klíč, omezený na API určené přístupem uživatelské role.
Více informací
Pro více informací o Dalux API si přečtěte tento článek: Dalux API.