Dieser Artikel zeigt Ihnen, wie Sie API-Identitäten für die Dalux Build API einrichten.
API-Identitäten ermöglichen den Zugriff auf die Dalux Build API mit spezifischen Benutzerrechten.
Durch das Erstellen einer API-Identität können Sie festlegen, welches Zugriffslevel auf das System gewährt wird – entweder Zugriff auf alle Firmendaten in sämtlichen Projekten oder eingeschränkten Zugriff auf bestimmte Gruppen in einzelnen Projekten.
Wenn Sie mehr über Dalux APIs erfahren möchten, lesen Sie diesen Artikel: Dalux API.
Hinweis
API-Identitäten werden die aktuelle API-Schlüsselfunktion ersetzen. Bitte beachten Sie, dass alle aktuellen API-Schlüssel im Firmenprofil nach dem 28. Februar 2026 ablaufen.
Alle API-Schlüssel müssen vor diesem Datum durch API-Identitäten ersetzt werden.
Wie man API-Identitäten einrichtet
API-Identitäten werden im Firmenprofil eingerichtet.
Benutzerrechte
Nur Firmenadministratoren können API-Identitäten einrichten, bearbeiten oder entfernen.
Um eine API-Identität zu erstellen, gehen Sie zu Firmenprofil
Einstellung
'API-Identitäten'.
Im Fenster API-Identitäten können Sie neue Identitäten anlegen und bestehende bearbeiten.
Sie können mehrere Identitäten erstellen, um die Zugriffe nach Bedarf zu verwalten. Um eine neue API-Identität einzurichten, klicken Sie auf Einrichten.
- Name - Der Name der API Identität, der in der Benutzeroberfläche angezeigt wird. Wir empfehlen, einen Namen zu wählen, der sowohl eindeutig als auch aussagekräftig ist.
- E-Mail - Die hier eingegebene E-Mail ist verantwortlich für die Validierung der API über eine Bestätigungs-E-Mail
- Firma - Der Name der Firma, für die die API-Identität bestimmt ist (Metadaten)
- Benutzerrechte der Firma - Legen Sie diese Berechtigung nur fest, wenn die API-Identität Zugriff auf Daten in allen Ihren Projekten haben soll. Die Benutzerrechte der Firma entsprechen denen der Rollen im Firmenprofil (Firmenadministrator und Firmenbeobachter). Dies kann geändert werden, nachdem die Identität erstellt wurde.
- Beschreibung - Eine kurze Beschreibung, die Details über die API-Identität enthält, wie den Zugriffsbereich, Kontaktdaten oder andere relevante Informationen.
Nachdem Sie die erforderlichen Informationen angegeben und die Nutzungsbedingungen für die API-Identität akzeptiert haben, wird eine Bestätigungs-E-Mail an die von Ihnen angegebene Adresse gesendet. Falls erforderlich, kann die E-Mail erneut gesendet werden. Sie können keinen API-Schlüssel generieren, bis die Identität verifiziert wurde.
Nach der Verifizierung der API-Identität können Sie Projekteinstellungen hinzufügen, die einen spezifischeren Projektzugriff ermöglichen. Dieser Schritt ist nur notwendig, wenn Sie keinen Firmenzugriff ausgewählt haben.
Klicken Sie auf 'Projekt hinzufügen', um fortzufahren. Wählen Sie dann das Projekt aus und fügen Sie die Benutzergruppe(n) hinzu.
Die Berechtigungen der ausgewählten Benutzergruppen steuern, worauf die API-Identität im Projekt Zugriff hat.
Wenn Sie fertig sind, klicken Sie auf 'Hinzufügen'.
Jetzt können Sie der API-Identität einen API-Schlüssel hinzufügen. Klicken Sie auf 'API-Schlüssel hinzufügen', um fortzufahren. Beim Hinzufügen eines API-Schlüssels müssen Sie die Dauer seiner Gültigkeit festlegen.
Ein API-Schlüssel wird nun generiert. Kopieren Sie den Schlüssel und bestätigen Sie, dass der Schlüssel kopiert wurde, und klicken Sie dann auf 'OK'.
WICHTIG
Der API-Schlüssel muss kopiert und gespeichert werden. Sie können auf den API-Schlüssel nicht mehr zugreifen, sobald das Fenster geschlossen ist.
Die API-Identität kann jetzt mit dem Dalux Build API verwendet werden.