Rozpocznij korzystanie z interfejsu API REST Notiondesk

Interfejs API REST Notiondesk umożliwia obsługę centrów pomocy za pomocą własnego kodu. Możesz wyświetlać swoje centra pomocy, czytać ich artykuły, kolekcje i rejestr zmian, zarządzać przekierowaniami stron, zmieniać ustawienia i branding, pobierać analizy i opinie czytelników oraz uruchamiać synchronizacje z Notion.

W tym artykule wyjaśniono, co potrafi interfejs API Notiondesk, kto może z niego korzystać i jak w ciągu kilku minut wysłać pierwsze żądanie.

Co można zrobić za pomocą interfejsu API Notiondesk

Gotowe do użycia skrypty znajdziesz w artykule Automatyzacja typowych zadań centrum pomocy za pomocą interfejsu API Notiondesk .

Kto może korzystać z interfejsu API Notiondesk

• Plan: Dostęp do API jest zawarty w planach Enterprise.

• Tworzenie kluczy: Właściciele i administratorzy obszarów roboczych tworzą klucze API w panelu.

• Uprawnienia: Klucz lub aplikacja nigdy nie mogą zrobić więcej niż osoba, która za nimi stoi, w Twojej przestrzeni roboczej. Zobacz Uwierzytelnianie za pomocą interfejsu API Notiondesk przy użyciu kluczy API .

Utwórz swoje pierwsze żądanie API Notiondesk

1. Utwórz klucz API

W panelu Notiondesk otwórz Ustawienia , następnie Deweloperzy > Klucze API i kliknij Utwórz klucz . Nadaj mu etykietę, wybierz zakres odczytu i skopiuj klucz, gdy się pojawi. Klucz zaczyna się od nd_wsk_ i jest wyświetlany tylko raz.

Zapisz w zmiennej środowiskowej:

2. Wypisz swoje centra pomocy

Odpowiedź zawiera listę wszystkich centrów pomocy w Twoim obszarze roboczym:

3. Wypisz artykuły centrum pomocy

To wszystko! Czytasz swoje centrum pomocy z poziomu kodu.

Podstawy API Notiondesk

export NOTIONDESK_API_KEY="nd_wsk_..."

curl "<https://api.notiondesk.so/sites>" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "object": "list",
  "data": [
    {
      "id": "c74781f6-1aea-4e17-ab23-bbb8b4d174b6",
      "full_domain": "help.example.com",
      "enabled": true,
      "default_locale": "en",
      "locales": ["en", "fr"]
    }
  ],
  "has_more": false,
  "next_cursor": null
}

curl "<https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/articles?page_size=10>" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

Notiondesk API czy Workspace MCP?

Notiondesk oferuje dwa sposoby obsługi centrów pomocy poza pulpitem nawigacyjnym. Dostęp do tych samych funkcji odbywa się różnymi drogami.

Notiondesk Punkt końcowy API

Często zadawane pytania

Co dalej?

• Uwierzytelnij się za pomocą interfejsu API Notiondesk, używając kluczy API

• Połącz swoją aplikację z Notiondesk za pomocą protokołu OAuth

• Obsługa błędów API Notiondesk, limitów szybkości i ponownych prób

• Zautomatyzuj typowe zadania centrum pomocy za pomocą interfejsu API Notiondesk