Einen API-Benutzer hinzufügen oder bearbeiten

SICHERHEIT  Zugriffsrechte mit Admin-Berechtigung zum Konfigurieren von Mitarbeitern/Benutzern (HR). Siehe Sicherheitseinstellungen für Admin.

NAVIGATION   > Admin > Erweiterungsmodule & Integrationen > Andere Erweiterungsmodule & Tools > Integrationscenter > Auswahl eines Integrationsanbieters >Kontextmenü > API-Benutzer hinzufügen

NAVIGATION   > Admin > Firmeneinstellungen & Benutzer > Mitarbeiter/Benutzer (Personal) > Mitarbeiter/Benutzer (Personal) > Mitarbeiter/Benutzer > Neu > Neuer API-Benutzer

Die auf der Seite Integrationscenter aufgelisteten externen Integrationen erfordern ein API-Benutzerkonto, um sicher mit der Anwendung kommunizieren zu können. Datto empfiehlt das Erstellen eines individuellen API-Benutzers für jede Integration, sodass Sie ganz einfach Sperrungsprobleme zurückverfolgen und Anwendungsaktivitäten überwachen können.

Ein API-Benutzer ist eine besondere Art von Konto, das für die Kommunikation mit der Autotask-API erforderlich ist. Diese Konten sind kostenlos, bieten jedoch keinen Zugriff auf die Autotask Benutzeroberfläche. API-Benutzer können nicht als ein Mitarbeiter zu Inhalten wie Verkaufschancen oder Tickets zugewiesen werden, jedoch können sie als Filter bei Feldern und in Widgets ausgewählt werden, die Datums-, Zeit- oder Audit-Stempel sind.

BEISPIEL  System-Audit-Felder namens Erstellt von oder Letzte Aktivität von beinhalten API-Benutzer in ihren Filteroptionen.

Idealerweise sollten Sie für jede Integration, mit der Ihre Entwicklerarbeiten, ein separates API-Benutzerkonto einrichten und vielleicht sogar ein separates API-Benutzer (System) (nur API) oder eine Sicherheitsstufe für API-Benutzer (System) kann keine Kosten (nur API) lesen. Somit können Sie die Zugriffsberechtigungen auf die von jeder Integration geforderten Bereiche anpassen.

Für Partnerintegrationen, die auf der Seite Integrationscenter erscheinen, sollten Sie API-Benutzer direkt über diese Seite hinzufügen. Siehe Integrationscenter.

Es stehen zwei ähnliche, aber unterschiedliche Standard-Systemzugriffsrechte für API-Benutzerkonten zur Verfügung. Bevor Sie Ihren API-Benutzer erstellen, ist es wichtig, die Zugriffsebene zu verstehen, die Ihre Mitarbeiter und Integrationspartner mit jedem Benutzer erhalten.

API-Benutzer (System) (nur API): Verwenden Sie dieses Systemzugriffsrecht für Mitarbeiter und Integrationspartner, die über die API mit Integrationen arbeiten und nicht über die Benutzeroberfläche auf Autotask zugreifen müssen. Das API-Benutzer (System)-Zugriffsrecht gewährt vollen Zugriff auf alle Autotask-Daten, einschließlich interner Kosten, für die Rollen, zu denen es gehört.

API-Benutzer (System) Kann keine Kosten einsehen (nur API): Wenn Sie einem Integrationspartner API-Benutzerzugriff gewähren müssen, dieser aber nicht die Möglichkeit haben soll, Ihre internen Kostendaten einzusehen, wählen Sie dieses Zugriffsrecht aus. Die API-Benutzer (System)-Rolle „Kann keine Kosten lesen“ und hat Zugriff auf alle Daten für die Rollen, zu denen sie gehört, aber Aufrufe an Abfrage geben keine Daten für Kostenfelder zurück. Die API ignoriert auch Aufrufe an Aktualisieren für Kostenfelder.

WICHTIG  Einem API-Benutzer ist das Erstellen von Mitarbeitern (Benutzern) untersagt. Es ist außerdem nicht gestattet, eigene Sicherheitseinstellungen zu modifizieren oder Multifaktor-Authentifizierungskonfigurationen (MFA) zu aktualisieren.

Einen API-Benutzer erstellen

Um ein API-Benutzerkonto zu erstellen, gehen Sie wie folgt vor:

  1. Um die Seite zu öffnen, nutzen Sie den/die Pfad(e) im vorstehenden Abschnitt Sicherheit und Navigation.
  2. Füllen Sie die folgenden Felder aus oder bearbeiten Sie sie:
Feld Beschreibung

Vor-/Nachname

Namensfelder

Auf den Vornamen, zweiten Vornamen und Nachnamen wird in Zahlreichen anderen Objekten verwiesen, häufig in Kombination mit einer Rolle, die eine Person in diesem Kontext übernimmt, oder einer Handlung, die sie vornimmt.

Geben Sie den Vornamen (Rufnamen), Nachnamen und optional den Zweitnamen der Person ein.

E-Mail-Adresse

 Diese E-Mail-Adresse wird für Benachrichtigungen verwendet, falls ein Problem mit der Integration auftritt. Geben Sie die E-Mail-Adresse einer Person an, die im Falle eines Fehlers Maßnahmen ergreifen kann.

Aktiv

Dieser Wert ist standardmäßig auf true gesetzt.

Gesperrt

Wenn ein API-Benutzer aufgrund wiederholter erfolgloser Anmeldeversuche gesperrt wurde und dieser Mitarbeiter das Benutzerkonto nicht über die Anmeldeseite entsperren kann, heben Sie die Markierung des Kontrollkästchens auf, um das Konto zu entsperren.
Die Anzahl der aufeinanderfolgenden erfolglosen Anmeldeversuche, nach denen das Benutzerkonto gesperrt wird, wird durch eine Systemeinstellung festgelegt. Siehe Systemeinstellungen für Site-Einstellungen.

Zugriffsrecht

In der Zugriffsrechtsliste werden lediglich aktive API-Zugriffsrechte (nur API) in aufsteigender alphabetischer Reihenfolge plus das aktuell zugewiesene Zugriffsrecht angezeigt, wenn dies nun inaktiv ist. Wählen Sie ein API-Zugriffsrecht aus.

Datumsformat

Das Datumsformat ist standardmäßig das Datumsformat der Standardgeschäftsstelle. In der Dropdown-Auswahl sind alle verfügbaren Datumsformate enthalten.

Zeitformat

Das Zeitformat ist standardmäßig das Zeitformat der Standardgeschäftsstelle. In der Dropdown-Auswahl sind alle verfügbaren Datumsformate enthalten.

Zahlenformat

Das Zahlenformat ist standardmäßig das Zahlenformat der Standardgeschäftsstelle. Die Dropdown-Auswahl enthält alle verfügbaren Zahlenformate.

Primäre Geschäftsstelle

Die primäre Geschäftsstelle gibt die mit dem API-Benutzer verbundene Zeitzone vor.
Feld Beschreibung

Schlüssel generieren

Klicken Sie auf diese Schaltfläche, um automatisch einen 15-stelligen Benutzernamen (Schlüssel) zu generieren.

Dieser wird im Feld Benutzername (Schlüssel) eingetragen.

Benutzername (Schlüssel)

Dieses Feld wird automatisch ausgefüllt, wenn über dem Feld auf die Schaltfläche Schlüssel generieren geklickt wird.

Sie können den automatisch generierten Benutzernamen überschreiben, sofern die folgenden Voraussetzungen erfüllt sind:

  • Muss Buchstaben und Zahlen enthalten
  • Kann Sonderzeichen enthalten (allerdings sind die folgenden Sonderzeichennicht zulässig: @ ( ) ; : [ ] | \ ")
  • Muss in Ihrer Datenbank eindeutig sein (einschließlich inaktive Mitarbeiter)

Geheimnis generieren

Klicken Sie auf diese Schaltfläche, um automatisch ein 25-stelliges Passwort (Geheimnis) zu generieren.

Dies wird im Feld Passwort (Geheimnis) eingetragen.

Passwort (Geheimnis)

Dieses Feld wird automatisch ausgefüllt, wenn über dem Feld auf die Schaltfläche Geheimnis generieren geklickt wird. Das Passwort entspricht den in den Systemeinstellungen konfigurierten Passwortanforderungen für die Grundeinstellungen. Wenn Ihre Zielanwendung keine 25-stelligen Passwörter zulässt, können Sie das automatisch generierte Passwort kürzen oder überschreiben.

Im Bearbeitungsmodus wird das Passwort nicht angezeigt. Wenn Sie das Passwort sehen möchten, müssen Sie auf Geheimnis generieren klicken, um ein neues Passwort zu generieren oder einzugeben.

Ab SOAP API-Version 1.6 und bei allen Versionen der REST API erfordern alle Aufrufe mit Ausnahme von getZoneInfo() eine Tracking-ID zum Identifizieren des API-Benutzers und folglich des Integrationsanbieters, von dem der Aufruf ausging. Mit dem Tracking-Identifikator können wir selektiv Integrationen und Anbieter deaktivieren, die Probleme verursachen, ohne dass dies Auswirkungen auf den API-Zugriff aller anderen Benutzer hat.

Die folgenden Optionsfelder sind verfügbar:

Optionsfeld Beschreibung

Optionsfelder
Integrationsanbieter Dies ist die Standardoption. Dies muss verwendet werden, wenn Ihr Anbieter eine Integration mit Autotask erstellt hat, die auf dieser Seite aufgelistet ist: Integrationscenter.
Benutzerdefiniert (interne Integration) Wählen Sie diese Option, wenn Sie Ihre eigene benutzerdefinierte Integration mit Autotask mithilfe unserer API erstellt haben. Es wird automatisch eine Tracking-ID generiert, und das Feld Name der internen Integration wird angezeigt und ist erforderlich.

Geben Sie einen eindeutigen Namen für Ihre interne Integration ein. Sie können diese Tracking-ID verwenden, um auf Version 1.6+ der SOAP-API und alle Versionen der REST-API nur für die Autotask-Instanz Ihres Unternehmens zuzugreifen.

Sobald der API-Benutzer gespeichert ist, kann die Tracking-Kennung nicht mehr geändert werden.

WICHTIG  Vorhandene Anbieterintegrationen funktionieren nicht mit einem benutzerdefinierten Tracking-Identifikator. Sie müssen den des Anbieters verwenden, der im Integrationscenter aufgelistet ist. Wenn Ihr Anbieter nicht aufgeführt ist, wenden Sie sich an den Anbieter.

Zusätzliche Felder
Integrationsanbieter (nur wenn das Optionsfeld Integrationsanbieter ausgewählt ist) Wenn Sie einen API-Benutzer über das Kontextmenü eines Anbieters auf der Seite Integrationscentererstellen, wird dieser Integrationsanbieter im Feld Integrationsanbieter ausgewählt. Die Optionsfelder und das Dropdown-Steuerelement werden deaktiviert.

Wenn Sie den API-Benutzer über die Seite Mitarbeiter erstellen, klicken Sie auf die Dropdown-Auswahl für das Feld Integrationsanbieter und wählen Sie Ihren Anbieter aus.
Anwendung (erscheint nur, wenn der ausgewählte Integrationsanbieter ein Middleware-Anbieter ist, der mehrere Integrationen anbietet Geben Sie den Namen der Middleware-Anwendung ein.
Name der internen Integration (nur wenn das Optionsfeld Benutzerdefiniert (interne Integration) ausgewählt ist) Geben Sie einen Namen für Ihre benutzerdefinierte Integration mit Autotask ein.
Tracking-Identifikator (nur wenn das Optionsfeld Benutzerdefiniert (interne Integration) ausgewählt ist) Dies ist der Tracking-Identifikator, der API-Aufrufe von diesem Benutzerkonto zu Autotask authentifiziert. Er muss in den SOAP-Header kopiert werden. Siehe Der API-Tracking-Identifikator.

Alle verfügbaren Kombinationen von „Bereich > Geschäftssparte“ sind unter Nicht verbunden aufgelistet. Sie können einen API-Benutzer mit einer Geschäftssparte verbinden, jedoch beachten Sie, dass alle Fehler für den Benutzer nicht sichtbar sind. Sofern Ihr Unternehmen nicht streng nach Geschäftssparten getrennt ist, raten wir von LOB-Zusammenschlüssen ab.

BEISPIEL  Wenn ein API-Benutzer nicht der Geschäftssparte zugewiesen ist, der die Rechnungspositionen auf einer Rechnung zugeordnet sind, wird die Rechnung nicht an QuickBooks übertragen.

Um den API-Benutzer mit einer oder mehreren Geschäftssparten zu verbinden, gehen Sie wie folgt vor:

  1. Wählen Sie eine oder mehrere Kombinationen von Bereich > Geschäftssparte aus und klicken Sie auf den Pfeil nach rechts. Die Kombinationen werden zur Registerkarte Verbunden verschoben. Klicken Sie bei Bedarf auf den Pfeil nach links, um eine Kombination zu entfernen.
  2. Um dem API-Benutzer das Anzeigen solcher Einträge zu ermöglichen, wählen Sie Mitarbeiter können Einträge ohne zugewiesene Geschäftssparte einsehen.
  3. Klicken Sie auf Speichern & Schließen.

Siehe Einen Benutzer auf der Mitarbeiterseite mit einer Geschäftssparte verbinden.

  1. Klicken Sie auf Speichern & Schließen.
  2. Aktualisieren Sie Ihre Integration mit den Zugangsdaten des neuen API-Benutzers. Die Anwendung sollte nun in der Lage sein, sich in Autotask zu authentifizieren.