Czytaj artykuły, kolekcje i wpisy w dzienniku zmian za pomocą interfejsu API Notiondesk

API Notiondesk odczytuje wszystko, co publikuje Twoje centrum pomocy: każdy artykuł i kolekcję w dowolnym języku, z zawartością w formacie Markdown, statusem publikacji i stanem synchronizacji, a także opublikowanymi wpisami w dzienniku zmian. Użyj go do utworzenia kopii zapasowej swojego centrum pomocy, przesłania treści do innego narzędzia lub sprawdzenia, które artykuły nie zostały zsynchronizowane.

API odczytuje treść, ale nigdy jej nie zapisuje. Twoje artykuły i kolekcje pozostają w Notion: aby je zmienić, edytuj je w Notion i uruchom synchronizację .

W interfejsie API Notiondesk kolekcję nazywa się kategorią .

Wybierz język

Każda trasa na tej stronie przyjmuje opcjonalny parametr zapytania locale, taki jak ?locale=fr. Bez niego odpowiedź używa domyślnego języka centrum pomocy. Na liście tras locale musi być jednym z języków obsługiwanych przez centrum pomocy: supported_locales centrum pomocy . Aby dodać języki, zapoznaj się z sekcją „Obsługa wielu języków” w Centrum pomocy .

Lista artykułów

Lista zawiera wszystkie artykuły w każdym statusie, wersje robocze i artykuły zarchiwizowane, w kolejności ich utworzenia. Przejrzyj ją za pomocą page_size i cursor, zgodnie z opisem w sekcji Paginate i w wersji Notiondesk API Requests .

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

{
  "object": "list",
  "data": [
    {
      "id": "1761580412",
      "title": "Connect your Notion workspace",
      "slug": "connect-your-notion-workspace",
      "status": "published",
      "categories": [
        {"id": "910000002", "name": "Connecting Notion", "slug": "connecting-notion", "locale": "en", "status": "published"}
      ],
      "tags": [{"name": "Setup", "slug": "setup"}],
      "locales_count": 2,
      "updated_at": "2026-10-18T14:39:03+00:00",
      "published_at": "2026-10-05T04:39:04+00:00",
      "locale": "en",
      "reading_time": 3,
      "views_count": 42,
      "reactions_percent": {"smiley": 50, "neutral_face": 25, "disappointed": 25},
      "source_notion_page_id": "3d5001d0-2470-8122-a1b2-c3d4e5f60789",
      "notion_article_page_url": "https://www.notion.so/3d5001d024708122a1b2c3d4e5f60789",
      "sync_in_progress": false,
      "sync_timeout": false,
      "sync_failed": false,
      "sync_error_code": null,
      "auto_translated": false
    }
  ],
  "has_more": true,
  "next_cursor": "OPAQUE_CURSOR"
}

Uwaga: Przefiltruj wyniki w kodzie, aby znaleźć każdy artykuł, którego ostatnia synchronizacja się nie powiodła, a następnie popraw go w Notion i zsynchronizuj ponownie .sync_failed: true

Przeczytaj artykuł w formacie Markdown

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

{
  "id": "1761580412",
  "type": "article",
  "title": "Connect your Notion workspace",
  "slug": "connect-your-notion-workspace",
  "text": "# Connect your Notion workspace\n\nOpen **Settings**, then **Notion**...",
  "url": "https://help.example.com/en/articles/connect-your-notion-workspace",
  "locale": "en",
  "last_updated": "2026-10-18T14:39:03+00:00",
  "category": {"id": "910000002", "title": "Connecting Notion", "slug": "connecting-notion"},
  "tags": ["setup"],
  "truncated": false,
  "author": {"name": "Ada Lovelace"},
  "status": "published",
  "content_available": true,
  "sync_in_progress": false,
  "sync_timeout": false,
  "sync_failed": false,
  "sync_error_code": null
}

Każdy status jest czytelny, więc możesz przeczytać wersję roboczą przed publikacją. Artykuł bez tłumaczenia w żądanym locale odpowiada 404 not_found.

Wyświetl kolekcje

Każdy element jest kolekcją w żądanym języku, w kolejności, w jakiej kolekcje zostały utworzone:

Odbuduj drzewo kolekcji za pomocą trzech pól:

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

{
  "id": "910000001",
  "name": "Getting Started",
  "slug": "getting-started",
  "updated_at": "2026-10-18T14:39:12+00:00",
  "locale": "en",
  "is_parent": true,
  "source_notion_page_id": "5d5001d0-2470-8122-a1b2-c3d4e5f60789",
  "notion_category_page_url": "https://www.notion.so/5d5001d024708122a1b2c3d4e5f60789",
  "sync_in_progress": false,
  "sync_timeout": false,
  "sync_failed": false,
  "sync_error_code": null,
  "parent_ids": [],
  "children_ids": ["910000002"],
  "locales_count": 2,
  "status": "published",
  "auto_translated": false
}

Lista nie zawiera liczby artykułów. Aby policzyć artykuły w kolekcji, wypisz je i pogrupuj według wartości categories. Dowiedz się, jak kolekcje organizują Twoje Centrum pomocy w artykule „Używanie kolekcji do organizowania artykułów” .

Przeczytaj zbiór

Odpowiedź ma taki sam kształt jak artykuł: type to category, title, slug, url, status, pola synchronizacji oraz text z własną zawartością kolekcji w postaci znaczników Markdown, puste, gdy ich nie ma.

Wyświetl wpisy w dzienniku zmian

Dziennik zmian zawiera listę opublikowanych artykułów umieszczonych w Twoich kolekcjach dzienników zmian, od najnowszych. Skonfiguruj go, korzystając z sekcji „Konfigurowanie dzienników zmian” w Centrum pomocy .

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/categories/910000001?locale=en" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

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

{
  "object": "list",
  "data": [
    {
      "id": "article:1761497350",
      "title": "Multilingual sync is now available",
      "slug": "multilingual-sync-is-now-available",
      "text": "Help centers on the Enterprise plan can now sync every configured locale in a single run instead of one language at a time.",
      "published_at": "2026-10-13T09:12:44+00:00",
      "last_updated": "2026-10-18T14:39:03+00:00",
      "tags": [],
      "url": "https://help.example.com/en/changelogs",
      "locale": "en"
    }
  ],
  "has_more": true,
  "next_cursor": "OPAQUE_CURSOR"
}

Warto wiedzieć:

• Wpis pojawia się tylko wtedy, gdy zbiór zmian zostanie opublikowany w żądanym języku.

• W centrum pomocy, które korzysta z kont gości, lista zawiera tylko wpisy widoczne dla wszystkich czytelników.

• Lista obejmuje maksymalnie 1000 najnowszych wpisów. Poza tym has_more jest false, nawet jeśli istnieją starsze wpisy.

• Rzadko, podczas chwilowego problemu z usługą, lista może pominąć lub powtórzyć wpis. Przeczytaj ją ponownie później, aby uzyskać pełną listę.

Błędy

Każda trasa może również odpowiadać na invalid_version, authentication_error, rate_limited i internal_error. Zobacz Obsługa błędów API Notiondesk, limitów przepustowości i ponownych prób .

Często zadawane pytania

Co dalej?

• Trigger Notion synchronizuje się z API Notiondesk

• Zarządzaj językami i automatycznym tłumaczeniem za pomocą interfejsu API Notiondesk

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