API

In diesem Artikel erfährst du mehr über die Lumiform API

In diesem Artikel

  • Was ist eine API?
  • Wofür kann ich die API verwenden?
  • Wie installiere ich die API?

Was ist eine API?

Eine API (Application Programming Interface) ist eine Schnittstelle zwischen zwei Programmen, über die zwei Systeme miteinander interagieren können. Mit Hilfe vorgegebener Programmiermodule können Daten von einem System zum anderen übertragen werden, um einen reibungslosen Arbeitsablauf zu gewährleisten.

 

Wofür kann ich die API verwenden?

Mit der API kannst du deine Daten aus Lumiform Formularen und Maßnahmen exportieren. Die Listen der Formulare und Maßnahmen sind seitenbasiert. Diese Antworten haben auch eine Meta- und eine Link-Eigenschaft, die für die Navigation nützlich sind. 

Wie installiere ich die API?

Bitte gib uns Bescheid, wenn du die API nutzen möchtest, und wir werden sie für dich freischalten.

Deine individualisierten API-Schlüssel findest du in der Lumiform Desktop App > Verwaltung > API-Schlüssel. Für die Installation benötigst du beide API-Schlüssel.



!!! Bitte teile deinen API Schlüssel NICHT mit anderen Personen, da diese Zugangsinformationen zu deinen Lumiform Daten enthalten. Fall der Schlüssel umbefugt genutzt wird, kannst du ihn jederzeit zurücksetzen. Denke daran, dass nach dem Zurücksetzen des Schlüssels auch die API neu angepasst werden muss, um weiterhin Daten zu erhalten.


Unter "API-Dokumentation" findet du ausführliche Informationen für Entwickler über die API und wie sie installiert wird.