API-Zugangsdaten
Für den Zugriff über die Programmierschnittstelle brauchen eigene Anwendungen API Zugangsdaten.
Sie finden sie unter Profil & Einstellungen → API Zugangsdaten.
Persönlich und weitreichend
Dies sind Ihre persönlichen API Anmeldedaten. Sie werden benötigt, um die API zu nutzen. Ihre persönlichen API Anmeldeinformationen gewähren Zugriff auf alle Daten in Ihren Spaces. Geben Sie diese Anmeldeinformationen nur an Dienste und Anwendungen von Drittanbietern weiter, denen Sie vertrauen.
Zwei Dinge daran sind wichtig:
- Persönlich, nicht space-gebunden. Die Zugangsdaten reichen so weit wie Ihr eigener Zugriff — über alle Spaces hinweg, auch über solche, die mit dem Vorhaben nichts zu tun haben.
- Sie hängen an Ihrem Konto. Verlässt jemand das Unternehmen und wird sein Konto gelöscht, hören alle damit gebauten Anbindungen auf zu funktionieren.
Zugangsdaten erstellen
- Klicken Sie auf Zugangsdaten erstellen.
- Vergeben Sie unter Wählen Sie einen Namen für Ihre Zugangsdaten eine Bezeichnung.
- Wählen Sie unter Diese Zugangsdaten gewähren: die Berechtigung.
- Bestätigen Sie mit Erstellen.
Berechtigung
| Auswahl | Umfang |
|---|---|
| Admin | Vollen Zugriff auf Ihre Spaces |
| Nur lesen | Nur Lesezugriff auf Ihre Spaces |
Im Zweifel „Nur lesen"
Für Auswertungen, Berichte und Datenexporte genügt Lesezugriff. Wählen Sie Admin nur, wenn die Anwendung tatsächlich schreiben muss.
Ein Auslesefehler in einem Skript mit Lesezugriff kostet nichts. Derselbe Fehler mit Vollzugriff kann Daten überschreiben.
Je Anwendung eigene Zugangsdaten
Legen Sie nicht einen Schlüssel für alles an, sondern einen je Anwendung — mit sprechendem Namen. Dann können Sie einzelne widerrufen, ohne alles andere lahmzulegen.
Nur einmal sichtbar
Sofort sicher notieren
Nach dem Erstellen erscheint:
Ihre Zugangsdaten sind verfügbar
Speichern Sie jetzt Ihren Autorisierungsschlüssel und Ihr Passwort.
Dies ist der einzige Zeitpunkt, zu dem die Zugangsdaten angezeigt oder heruntergeladen werden können. Später können sie nicht mehr wiederhergestellt werden. Sie können Ihre API Zugangsdaten jedoch jederzeit löschen und neue erzeugen.
Die Zugangsdaten bestehen aus Autorisierungsschlüssel und Passwort.
Legen Sie beides in einem Passwortmanager ab — nicht in einer Textdatei, einem Chat oder einer E-Mail.
Geht etwas verloren, löschen Sie die Zugangsdaten und erzeugen neue. Die Anbindung muss dann angepasst werden.
Sicherheit
Wo Zugangsdaten nicht hingehören
- Nicht in öffentliche Repositories. Automatische Scanner finden solche Schlüssel binnen Minuten.
- Nicht in Frontend-Code. Alles, was im Browser läuft, ist einsehbar.
- Nicht in Chats, Tickets oder Folien.
- Nicht in Screenshots.
Regelmäßig aufräumen
Gehen Sie die Liste Ihrer Zugangsdaten durch und löschen Sie, was nicht mehr gebraucht wird. Ein vergessener Schlüssel bleibt gültig, bis ihn jemand entfernt.
Woran Sie API-Zugriffe erkennen
Einträge, die über die Schnittstelle entstanden sind, zeigen in der Spalte Erstellt von den Wert API Zugangsdaten statt eines Personennamens.
Im Versionsverlauf erscheinen entsprechende Änderungen als System oder Flow.
Nützlich bei der Fehlersuche
Ändert sich ein Wert unerwartet, klärt der Versionsverlauf schnell, ob ein Mensch, ein Flow oder eine angebundene Anwendung dahintersteckt.
Technische Eckdaten
Für die Entwicklung einer Anbindung:
| Merkmal | Wert |
|---|---|
| Schnittstellenversion | 2 |
| Aufbau | Ressourcen verweisen über Verknüpfungen aufeinander |
| Anmeldung | Autorisierungsschlüssel und Passwort |
| Space-Kennung | in den Space-Einstellungen unter Space Identifikator |
| Feldbezeichner | über Feldkey verwalten am jeweiligen Feld |
Diese Dokumentation ist keine Schnittstellenreferenz
Eine vollständige Beschreibung der verfügbaren Aufrufe ist nicht Teil dieser Nutzerdokumentation. Wenden Sie sich für Entwicklerunterlagen an den Support über den Chat.
Braucht es wirklich die Schnittstelle?
Oft geht es einfacher
| Ziel | Einfacherer Weg |
|---|---|
| Daten aus einem System übernehmen | CSV-Import |
| Daten an ein System übergeben | CSV-Export oder Webhook |
| Ein anderes System aufrufen | Flow-Schritt HTTP-Anfrage |
| Flow von außen starten | Webhook-Auslöser |
| Daten anzeigen | Portal |
Die Schnittstelle lohnt sich, wenn eine eigene Anwendung dauerhaft und in beide Richtungen mit ApptiveGrid arbeitet.