API-Schlüssel

Mit einem API-Schlüssel greifst Du auf die REST-API von Offpaper zu. Darüber lassen sich zum Beispiel Formulareinsendungen automatisiert exportieren - etwa über ein Power-Query-Skript für einen automatisierten Excel-Export, das Du auf der Detailseite eines Formulars generieren kannst - oder in ein eigenes System übernehmen. Diese Seite beschreibt, wie Du einen API-Schlüssel anlegst, anzeigst und löschst. Die eigentliche Nutzung der REST-API (Endpunkte, Datenformate) ist ein Thema für Entwickler und nicht Teil dieses Handbuchs.

Begriff im Produkt uneinheitlich

Offpaper selbst verwendet an verschiedenen Stellen leicht unterschiedliche Schreibweisen - „API-Key“ im Fließtext, „API Key“ im Modal-Titel, „API-Keys“ als Seitenüberschrift und „Rest-API Schlüssel“ im Menü der Seitenleiste. Dieses Handbuch verwendet einheitlich den Begriff „API-Schlüssel“. Suchst Du die Funktion im Produkt, findest Du sie in der Seitenleiste unter dem Namen „Rest-API Schlüssel“.

Wo finde ich die API-Schlüssel?

Seitenleiste → Einstellungen (Zahnrad-Icon) → Rest-API Schlüssel. Dieser Menüpunkt ist ausschließlich für Administratoren sichtbar und erreichbar (siehe Rollen & Rechte). Die Seite selbst trägt die Überschrift „API-Keys“.

Nur im Expert Plan verfügbar

Die gesamte Funktion ist an den Expert Plan gebunden. Ohne Expert Plan zeigt die Seite lediglich einen Hinweis auf den Expert Plan mit einem Button zum Upgrade - weder den Button zum Erstellen eines Schlüssels noch den Link zur API-Dokumentation.

Sobald Schlüssel angelegt sind, zeigt Offpaper eine Tabelle mit den Spalten Name, Erstellt am, Erstellt von, Schlüssel und Aktionen. In der Spalte Schlüssel stehen nur die letzten Zeichen, der Rest ist maskiert - der vollständige Schlüssel ist ausschließlich direkt nach dem Erstellen sichtbar.

Einen neuen API-Schlüssel anlegen

1. Klicke oben auf der Seite auf API-Key erstellen. Es öffnet sich das Modal „API Key erstellen“.
2. Lies den Sicherheitshinweis im Modal (siehe eigener Abschnitt unten) und aktiviere die Checkbox „Hiermit bestätigst Du unsere Nutzungsbedingungen.“.
3. Fülle das Pflichtfeld Name aus, z. B. „Schlüssel für Excel Import“. Der Name dient nur zur eigenen Wiedererkennung in der Tabelle und hat keine technische Funktion.
4. Klicke auf Speichern. Der Button ist erst aktiv, wenn Name und Checkbox ausgefüllt bzw. aktiviert sind.
5. Direkt danach öffnet sich der Dialog API-Key wurde erstellt - die einzige Gelegenheit, den vollständigen Schlüssel zu sehen. Kopiere ihn über den Button Kopieren und lege ihn an einem sicheren Ort ab, z. B. in deinem Passwort-Manager.
6. Bestätige mit der Checkbox Ich habe den Schlüssel gespeichert. und schließe den Dialog mit Fertig.

Der Schlüssel wird nie wieder angezeigt

Nach dem Schließen des Dialogs zeigt Offpaper den vollständigen Schlüssel aus Sicherheitsgründen nie wieder an - in der Tabelle bleiben nur die letzten Zeichen sichtbar. Hast Du das Kopieren versäumt, lösche den Schlüssel einfach und lege einen neuen an.

Wie ein Passwort behandeln

Offpaper weist im Modal ausdrücklich darauf hin, dass jeder, der den API-Key kennt, damit Zugriff auf alle Formulareinsendungen und weitere Daten in Offpaper erhält - er sollte deshalb wie ein Passwort behandelt werden. Ein API-Schlüssel lässt sich nicht auf bestimmte Formulare oder Bereiche einschränken und hat auch kein Ablaufdatum - er gibt vollen Lesezugriff auf alle Formulareinsendungen deines Arbeitsbereichs. Gib ihn nur weiter, wenn das wirklich notwendig ist, und behandle ihn genauso vertraulich wie ein Passwort.

Name lässt sich nachträglich nicht ändern

Einen API-Schlüssel umzubenennen ist nicht möglich - Du kannst nur neue Schlüssel erstellen und bestehende löschen. Wähle den Namen deshalb gleich so, dass Du in der Tabelle später erkennst, wofür der Schlüssel verwendet wird.

Einen Schlüssel löschen

Einen nicht mehr benötigten (oder versehentlich nicht kopierten) Schlüssel entfernst Du über das Papierkorb-Symbol (Tooltip „Löschen“) in der jeweiligen Tabellenzeile.

Löschen wirkt sich sofort auf alle Anwendungen aus, die den Schlüssel verwenden

Offpaper weist im Dialog „API-Key löschen?“ darauf hin, dass der Schritt nicht rückgängig gemacht werden kann und alle Anfragen mit diesem Key künftig fehlschlagen. Bestätige mit Ja, löschen, oder brich den Dialog ab, ohne zu löschen. Prüfe vor dem Löschen, ob der Schlüssel noch in einem eigenen Skript oder System verwendet wird - danach funktionieren alle Anfragen mit diesem Schlüssel nicht mehr.

Siehe auch:

• Rollen & Rechte - warum diese Seite nur für Administratoren sichtbar ist
• Für Entwickler, die die REST-API direkt ansprechen wollen, verlinkt der Button API-Docs auf der Seite zu einer externen Entwickler-Dokumentation.