REST API

Jak dostać klucz API w Nozbe

Naciśnij ikonkę zębatki -> Ustawienia -> Tokeny API i kliknij na “Dodaj nowy klucz dostępu” by wygenerować swój token API.

Możesz tam utworzyć nowy token i go nazwać, np. “API Nozbe”. Możesz oczywiście wygenerować więcej kluczy dostępu i użyć każdego do innej integracji/aplikacji.

UWAGA: nie udostępniaj nikomu swojego klucza API! Zachowaj klucz API w sekrecie. Udostępnienie go komuś byłoby jak przekazanie mu swojego adresu email oraz hasła. Jeśli wyślesz komuś swój klucz API lub udostępnisz go w Internecie, ryzykujesz wyciekiem swoich danych.

Użyj apikey <API_token> jako nagłówka uwierzytelnienia gdy wchodzisz w Nozbe Rest API.

Jak używać interaktywnej dokumentacji API

1. Otwórz interaktywną dokumentację Nozbe API dostępną na https://api4.nozbe.com/v1/api
2. Wybierz “Authorize” i podaj apikey <API_token>

3. Zacznij używać interaktywnej dokumentacji API poprzez wybranie opcji w danej sekcji i wykonanie żądań poprzez Execute.

Jak wygenerować klientów API za pomocą generatora OpenAPI

Nozbe udostępnia dokument OpenAPI 3.0 na:

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

Integracja z API Nozbe może być uproszczona poprzez wygenerowanie kodu klienta za pomocą Generatora OpenAPI (https://openapi-generator.tech/).

Lista dostępnych generatorów klienta jest dostępna tutaj:

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

Przykładowe integracja Ruby z API Nozbe:

1. Zainstaluj Generator OpenAPI https://openapi-generator.tech/docs/installation/
2. Wygeneruj kod klienta z (“ruby” można zastąpić innym dostępnym generatorem):

openapi-generator-cli generate -i https://api4.nozbe.com/v1/api/openapi.yaml -g ruby -o /tmp/test/

3. Jeśli plik README.md został wygenerowany, postępuj według instrukcji w pliku by skompilować i ustawić klienta. Upewnij się, że używasz apikey <API_token> jako nagłówka uwierzytelnienia. Wygenerowane kody klienta API mogą być teraz używane do komunikacji z serwerem Nozbe. Poniżej można zobaczyć przykład użycia wygenerowanych funkcji klienta Ruby by otrzymać projekt Pojedyncze i stworzyć zadanie z komentarzem: