Interfejs API REST Notiondesk umożliwia zarządzanie centrami pomocy z poziomu kodu. Czytaj artykuły, kolekcje i wpisy w dzienniku zmian, zarządzaj przekierowaniami stron, aktualizuj ustawienia, branding i integracje, eksportuj analizy i opinie czytelników oraz uruchamiaj synchronizacje z Notion. Nadal tworzysz treści w Notion: interfejs API odczytuje je i synchronizuje, a nie edytuje.
Podstawowy adres URL
Wysyłaj każde żądanie do https://api.notiondesk.so. Ścieżki punktów końcowych zaczynają się od /sites, a żądania i odpowiedzi korzystają z JSON.
Uwierzytelnianie
Każde żądanie zawiera token nośnika w nagłówku Authorization:
curl https://api.notiondesk.so/sites \
-H "Authorization: Bearer $NOTIONDESK_API_KEY"- Klucz API : do własnych skryptów, zaplanowanych zadań i CI. Właściciel obszaru roboczego lub administrator tworzy go w Ustawieniach > Deweloperzy > Klucze API. Klucze zaczynają się od
nd_wsk_i działają dla każdego centrum pomocy w obszarze roboczym. Zobacz Uwierzytelnianie za pomocą API Notiondesk przy użyciu kluczy API .
- Token dostępu OAuth : dla aplikacji, z którymi łączą się inni klienci Notiondesk. Zobacz Łączenie aplikacji z Notiondesk za pomocą OAuth .
Każdy punkt końcowy potrzebuje jednego zakresu: read, write, sync lub admin. Strona każdego punktu końcowego pokazuje, który to zakres.
Przykłady kodu
Każda strona punktu końcowego zawiera listę parametrów, treść żądania i odpowiedzi, a także gotowe do skopiowania przykłady kodu w językach cURL, JavaScript i Python.
Przewodniki
- Rozpocznij korzystanie z interfejsu REST API Notiondesk : Twoje pierwsze żądanie, krok po kroku.
- Poradniki wprowadzające : klucze API, OAuth, paginacja i wersje, błędy i limity przepustowości oraz przykłady.
- Webhooki : odbierz żądanie na swoim serwerze, gdy coś się wydarzy w Notiondesk.