Authentifizierung
Authentifizierungs-Header
Wenn du eine Anfrage an diese API schickst, musst du einen Header namens X-ApiKey hinzufügen und deinen API-Schlüssel als Wert einfügen.
- So erkennt das System, dass du autorisiert bist, die API zu verwenden.
- X-ApiKey ist der Name des Headers, den du in deine API-Anfrage einfügen musst.
- Im Header bedeutet, dass du deinen API-Schlüssel im Header deiner Anfrage platzieren solltest.
- Der API-Schlüssel wird für die Authentifizierung benötigt, um deine Identität zu verifizieren und dir Zugriff auf die API zu gewähren.
API-Schlüssel generieren
-
Gehe zur Unternehmensprofilseite
- Öffne die Unternehmensprofilseite in der Numarics-App.
- Suche den Abschnitt API-Schlüssel.
-
Ausgangszustand (keine API-Schlüssel)
- Wenn noch keine API-Schlüssel vorhanden sind, wird dieser Abschnitt leer sein.
-
Bestehende API-Schlüssel
- Wenn bereits API-Schlüssel vorhanden sind, werden sie hier aufgelistet.
- Klicke auf die Schaltfläche, um einen neuen API-Schlüssel hinzuzufügen.
-
API-Schlüssel generieren
- Es öffnet sich ein modales Fenster.
- Gib einen Namen für den API-Schlüssel ein (erforderlich).
- Optional kannst du die Gültigkeitsdauer festlegen.
- Klicke auf „Fertig“, um den API-Schlüssel zu erstellen.
- Ein neues modales Fenster bestätigt die Generierung des API-Schlüssels.
-
Kopieren und Schliessen
- Kopiere den API-Schlüssel mit der bereitgestellten Schaltfläche.
- Alternativ kannst du das Symbol verwenden, um den Schlüssel auszuwählen und zu kopieren.
- Schliesse das modale Fenster.
- Der neue API-Schlüssel wird jetzt im Abschnitt API-Schlüssel aufgelistet.
-
Wichtiger Hinweis
- Einmal erstellte API-Schlüssel können nicht erneut generiert werden.
- Wenn ein API-Schlüssel verloren geht, musst du einen neuen generieren, indem du diesen Prozess wiederholst.
-
API-Schlüssel deaktivieren (falls erforderlich)
- Klicke auf die Aktion, um einen aktiven API-Schlüssel zu deaktivieren.
- Bestätige die Deaktivierung im erscheinenden modalen Fenster.