Functional profile
The functional profile should always be used if employees want to use the API in different branches. The existing user login data in AMPAREX can be used for a functional profile
Um auf die API zugreifen zu können muss man sich zuerst authentifizieren. Ein technischer Zugang erfolgt über Zugangsdaten, die im AMPAREX eingerichtet werden. Dazu wird der technische Login immer dann benutzt, wenn technische Daten abgerufen oder gespeichert werden sollen. Typischerweise z. B. allgemeine Exporte oder Kalendersynchronisationen. Dabei ist man auf eine Filiale und einen Benutzer beschränkt.
Im Gegensatz zum technischen Login gibt es noch einen fachlichen Login. Dieser wird immer dann benötigt, wenn sich verschiedene Mitarbeiter über die API anmelden möchten. Mögliche Anwendungsfälle sind z. B. Mobile APPs mit Login von Mitarbeiten.
Fachlicher Login
Der fachliche Login sollte immer erfolgen, wenn sich mehrere Mitarbeiter in unterschiedlichen Filialen über die API anmelden möchten. Für einen fachlichen Login können die bestehenden Benutzer Logindaten in AMPAREX verwendet werden.
| Hinweis | ||
|---|---|---|
| ||
Für einen fachlichen Login muss ein sicheres Passwort in AMPAREX verwendet werden (Groß-/Kleinbuchstaben mit Zahlen und Sonderzeichen). Ist das Passwort unsicher wird der Login über die API abgelehnt. Dabei erhalten sie aus Sicherheitsgründen aber keine Hinweise in der Fehlermeldung. Die Fehlermeldung ist ein HTTP Status Code 401 (Unauthorized) ohne weiteren Hinweis. | ||
| ||
The functionalprofile requires a secure password to be used on AMPAREX (upper/lower case letters, numbers and special characters). Users with passwords not meeting that criteria won’t be able to login and use the API. For security reasons they won’t receive any detailed information in the error message regarding the reasons of not being able to login. The error message will have an HTTP status code 401 (unauthorized) notice only. |
| Beschreibung | |
|---|---|
| In order to be able to use the functional profile, the service access data must be configured in a similar way to the technical profile. Here, however, the access type needs to bew set to ‘AMPAREX user/password’. Now it is possible to access the API with ones AMPAREX login credentials. The use of the ‘Alias’ and the subsequent use of the ‘Bearer token’ remains unchanged. |
| The functional profile login initially applies to AMPAREX user’s standard branch. If an API user wants to register for another branch, the ‘axlogin’ method could be used:
| Beschreibung |
| Um den fachlichen Login verwenden zu können, müssen ähnlich zu dem technischen Login die Servicezugangsdaten konfiguriert werden. Hierfür wird jedoch der Zugangstyp auf "AMPAREX Benutzer/Passwort" gesetzt. Nun ist es möglich, sich über den /Login mit seinem AMPAREX-Benutzer anzumelden. Die Verwendung des "Alias" und die nachfolgende Verwendung des "Bearer Tokens" bleiben hierbei identisch zu dem fachlichen Login. |
| Der fachliche Login erfolgt initial mit einer zuvor in AMPAREX konfigurierten Standard-Filiale für das Benutzerkonto. Möchte man sich für eine andere Filiale anmelden, kann die Methode /axlogin verwendet werden:
|
