f

REST API

So erhalten Sie Ihren Nozbe API-Schlüssel

Um Ihr API-Token zu generieren, öffnen Sie bitte Ihre Kontoeinstellungen -> API-Token und klicken Sie auf „Neues Token hinzufügen“.

API Tokens

Sie können dort ein neues Token erstellen und es zum Beispiel „Nozbe API“ nennen. Sie können weitere Token generieren, um jedes Token mit unterschiedlichen Integrationen/Apps zu verwenden.

Neues Token hinzufügen

Verwenden Sie apikey <API_token> als Autorisierungs-Header, wenn Sie auf die REST-API von Nozbe zugreifen

Verwendung der interaktiven API-Dokumentation

  1. Gehen Sie zur interaktiven Dokumentation der Nozbe API unter https://api4.nozbe.com/v1/api
  2. Wählen Sie „Autorisieren“ und geben Sie „apikey <API_token>“ an
  1. Beginnen Sie mit der Verwendung der interaktiven API-Dokumentation, indem Sie auf dem Endpunkt „Ausprobieren“ auswählen und Anfragen mit „Ausführen“ ausführen.

So generieren Sie API-Clients mit OpenAPI Generator

Nozbe bietet OpenAPI 3.0-Dokumentation unter der Adresse:

https://api4.nozbe.com/v1/api/openapi.yaml

Die Integration mit der Nozbe API kann vereinfacht werden, indem Client-Code mit OpenAPI Generator (https://openapi-generator.tech/) generiert wird.

Die Liste der verfügbaren Client-Generatoren finden Sie hier:

https://openapi-generator.tech/docs/generators#client-generators

Beispielhafte Ruby-Integration mit Nozbe API:

  1. Installieren Sie OpenAPI Generator https://openapi-generator.tech/docs/installation/
  2. Client-Code generieren mit („ruby“ kann durch einen anderen verfügbaren Generator ersetzt werden):
openapi-generator-cli generate -i https://api4.nozbe.com/v1/api/openapi.yaml -g ruby -o /tmp/test/
  1. Wenn die Datei „README.md“ erstellt wurde, befolgen Sie die Anweisungen in dieser Datei, um den Client zu kompilieren und einzurichten. Stellen Sie sicher, dass Sie „apikey <API_token>“ als Autorisierungsheader verwenden. Generierte Client-Methoden können jetzt verwendet werden, um mit dem Nozbe Server zu kommunizieren. Nachfolgend finden Sie ein Beispiel für die Verwendung generierter Ruby-Client-Methoden, um ein Projekt für einzelne Aufgaben abzurufen und eine Aufgabe und einen Kommentar zu erstellen.