API und Integrationen

Erstelle, prüfe und widerrufe API-Keys für die öffentliche Ninox API in einem Arbeitsbereich.

Nutze API und Integrationen, um den API-Zugriff für einen Arbeitsbereich zu verwalten. Hier erstellst, prüfst und widerrufst du API-Keys für die öffentliche Ninox API. Damit können externe Systeme programmgesteuert auf Daten des Arbeitsbereichs zugreifen.

In API und Integrationen kannst du:

• API-Keys für externe Tools erstellen

• Geltungsbereich, Ablauf, Ersteller und Erstellungsdatum jedes API-Keys prüfen

• API-Keys widerrufen, die du nicht mehr brauchst

Du kannst außerdem Swagger UI öffnen oder JSON schema und YAML schema aufrufen.

Jeder API-Key funktioniert nur im aktuellen Arbeitsbereich.

Einen API-Key erstellen

Erstelle pro Integration einen eigenen API-Key. So sind Prüfung und Widerruf einfacher.

1

API und Integrationen öffnen

Wenn du nicht schon auf dem Einstellungs-Screen bist, klicke in der Hauptnavigation auf das Zahnradsymbol Einstellungen.

Wähle unter ARBEITSBEREICH API und Integrationen.

2

Die Erstellung starten

Klicke auf API-Key erstellen.

3

Die Details des API-Keys eingeben

Gib in API-Key-Name einen aussagekräftigen Namen für den API-Key ein. Nutze einen Namen, an dem du die Integration oder den Zweck später schnell erkennst.

Wähle in Ablaufdatum Datum und Uhrzeit, zu denen der API-Key ablaufen soll. Wenn der API-Key kein Ablaufdatum haben soll, lasse dieses Feld leer.

4

Den API-Key erstellen

Klicke auf API-Key erstellen.

Nutze den API-Key im externen System, das die Ninox API aufruft.

API-Keys prüfen

Nutze die API-Key-Liste, um den gesamten API-Zugriff für den Arbeitsbereich zu prüfen.

Für jeden API-Key zeigt Ninox:

• API-Key-Name

• Geltungsbereich

• Läuft ab am

• Erstellt von

• Erstellungsdatum

Prüfe diese Liste regelmäßig, um alten oder ungenutzten Zugriff zu entfernen.

Einen API-Key widerrufen

Widerrufe einen API-Key, wenn eine Integration eingestellt, ersetzt oder nicht mehr vertrauenswürdig ist.

1

Die API-Key-Liste öffnen

Öffne API und Integrationen unter ARBEITSBEREICH.

2

Den API-Key auswählen

Finde den API-Key, den du entfernen willst. Öffne sein Aktionsmenü oder wähle ihn in der Liste aus.

3

Den API-Key widerrufen

Wähle die Aktion zum Widerrufen.

Die API-Referenz öffnen

Nutze die Links oben auf dem Screen, wenn du eine Integration erstellst oder testest.

• Swagger UI öffnet die interaktive API-Referenz.

• JSON schema stellt das API-Schema im JSON-Format bereit.

• YAML schema stellt das API-Schema im YAML-Format bereit.

Die API-Nutzung des Arbeitsbereichs kannst du unter Abonnement und Nutzung verfolgen.