- 01 Sep 2023
- 2 Minuten zu lesen
- Drucken
- DunkelHell
- pdf
Airtable Enterprise-API
- Aktualisiert am 01 Sep 2023
- 2 Minuten zu lesen
- Drucken
- DunkelHell
- pdf
Der Zugriff auf die Enterprise-API-Dokumentation von Airtable ist möglich, wenn Sie sich bei einem Airtable Konto anmelden, das mit einem Enterprise-Workspace verbunden ist. Der folgende Artikel gibt einen kurzen Überblick über die API von Airtable, die speziell für unsere Enterprise-Kund*innen entwickelt wurde.
Übersicht
Wenn Sie oder Ihr Team über Entwicklungserfahrung verfügen, können Sie mit Hilfe unserer API bestimmte programmatische oder Sammelaktionen durchführen, die andernfalls nur mit erheblichem manuellem Aufwand und vielen sich wiederholenden Arbeitsschritten erledigt werden könnten. Um auf die Enterprise API zugreifen und sie nutzen zu können, benötigen Sie:
- ein Airtable Konto
- einen oder mehrere Workspaces im Airtable Enterprise-Abo
Die Airtable Enterprise-API verwendet eine schlüsselbasierte (Token-)Authentifizierung, ebenso wie die Web-API von Airtable. Bei allen Anfragen muss im Authorization-Header der API-Schlüssel angegeben werden. Bei Anmeldung in einem Enterprise-Konto ist die für Enterprise relevante Dokumentation mit einem violettfarbenen „Enterprise“-Symbol gekennzeichnet:
Alle Anfragen an diese Endpunkte müssen außerdem server-seitig gestellt werden. Client-seitige Anfragen sind nicht zulässig, da sie den API-Schlüssel des*der Benutzer*s*in offenlegen würden.
Geben Sie Ihren API-Schlüssel an niemanden weiter (auch nicht an Mitarbeiter*innen von Airtable), da es sich dabei um ein Passwort handelt, das Zugriff auf alle Ihre Bases erlaubt. Wenn Sie Ihren API-Schlüssel versehentlich offenlegen, sollten Sie Ihren API-Schlüssel so schnell wie möglich unter https://airtable.com/account neu generieren.
Nutzung der Airtable Enterprise-API
Über das Interface des Admin Panel können Sie Benutzer*innen, Bases und Workspaces überprüfen und unternehmensweite Sicherheitseinstellungen vornehmen. Mit der Enterprise-API können Teams ihr Konto auch außerhalb der Benutzeroberfläche des Admin Panel programmatisch verwalten. So können beispielsweise Benutzer*innen verwaltet, Zugriffsberechtigungen aktualisiert und Bases, Tabellen und Ansichten verwaltet werden.
Mitunter kann es auch vorkommen, dass einige Teams zusätzlich zu den von einer API-Anfrage abgerufenen Informationen eigene Metadaten hinzufügen möchten, z. B. Abteilungsinformationen, Manager*innen oder Abrechnungseinheiten. So können sie ihre Unternehmensressourcen effektiver organisieren und bei Bedarf entsprechende Maßnahmen ergreifen.
Mit der Skripterweiterung von Airtable und der Aktion „Skriptautomatisierung ausführen“ können Entwickler*innen einen JavaScript-Code schreiben, der in ihre benutzerdefinierte Anwendung eingebettet ist. In Verbindung mit der Enterprise API können Entwickler*innen damit eine Reihe von programmatischen Funktionen ausführen. Im nächsten Abschnitt geht es um Beispiel-Anwendungsfälle.
Beispiel-Anwendungsfälle.
Die im Folgenden beschriebenen API-Endpunkte stellen nur einige der Möglichkeiten dar, wie unsere API aus administrativer/IT-Sicht genutzt werden kann.
Sicherheit und Benutzerverwaltung
- Benutzerinformationen abrufen: ruft alle Informationen zu einem*einer einzelnen Benutzer*in ab.
- Benutzerfreigabe aufheben: Freigabe eines*einer Benutzer*in für alle Workspaces, Bases und Interfaces des Unternehmens aufheben.
- Einzel- oder Mehrfachbenutzer*innen (Batch-Verarbeitung) verwalten: Aktualisieren von E-Mails und/oder Aktivieren/Deaktivieren von Benutzer*innen für Onboarding- und Offboarding-Prozesse.
- API-Schlüssel für den*die angegebene*n Benutzer*in löschen (widerrufen) und/oder neu generieren.
- Erstellen oder abrufen von Audit-Protokollen: Anfordern und Abrufen von Audit-Protokollen für Aktionen, die in Workspaces und Bases des Unternehmens durchgeführt wurden.
- Freigabelinks verwalten: Über diesen Endpunkt können Admins Base-Freigabelinks in ihrer Organisation zu verwalten.
Base und Workspace verwalten
- Erstellen von Bases, Tabellen und Feldern – Als Alternative zum Duplizieren einer Base über die Benutzeroberfläche können Sie auch diese API-Methoden verwenden, um Airtable Bases, Tabellen und Felder programmatisch zu erstellen. Bitte beachten Sie, dass einige erweiterte Feldarten, wie z. B. Formeln, nicht über die API erstellt werden können.
- Ansichten programmatisch auflisten und entfernen.
- Mitwirkende verwalten – Hinzufügen eines*einer Einzelbenutzer*in zu einer Base oder zu einem Workspace. Sie können auch die Benutzerberechtigungen für eine Base oder für einen Workspace aktualisieren.
Die meisten der oben beschriebenen Methoden stehen nur Benutzer*innen mit Enterprise-Admin-Berechtigungen zur Verfügung.