# REST API

# Dokumentation

Die Dokumentation wurde in Postman erstellt und wird Ihnen hier als Postman-Collection angeboten. Bitte laden Sie sich Postman herunter und importieren Sie die Collection, dann erhalten Sie einen Ordner mit allen API-Requests samt Felder inkl. Beschreibung. Bitte beachten Sie, dass Sie die URL jeweils auf Ihre one folder - Installation abändern müssen.

Die Collection-Datei finden Sie links in der Sidebar zum Download.

Sollten noch Fragen bestehen, dann zögern Sie nicht und schreiben uns eine E-Mail an <support@one-folder.com>

# API-Key

Um die REST-API benutzen zu können, müssen Sie einen API-Key haben.

Wenn Sie die Cloud-Version benutzen, dann schreiben Sie uns bitte eine E-Mail an [support@one-folder.com, ](mailto:support@one-folder.com,)dann lassen wir Ihnen einen API-Key zukommen.

Wenn Sie eine selbst gehostete Version haben, dann begeben Sie sich bitte mit der Konsole in den One-Folder-Container und wechseln Sie in das one folder-Verzeichnis und führen sie den Befehl **rails c** aus.

Danach bitte **User.unscoped.find\_by(email: '[EMAIL@MAIL.DE'](mailto:EMAIL@MAIL.DE')).generate\_api\_key** ausführen und es wird Ihnen Ihr neuer API-Key angezeigt.

# Rate-Limiting

Standardmäßig liegt das Rate-Limiting bei max. 20 Requests pro Stunde pro IP.

Das Limit kann jederzeit gerne für Sie erhöht werden, wenden Sie sich hierzu bitte an <support@one-folder.com>.