Przeczytaj informacje w centrach pomocy za pomocą interfejsu API Notiondesk

Interfejs API Notiondesk umożliwia wyświetlenie listy wszystkich centrów pomocy w obszarze roboczym, odczytanie konfiguracji każdego z nich oraz sprawdzenie statusu zaplanowanej synchronizacji Notion. Zacznij od tego: centrum pomocy id, które te trasy zwracają, to site_id każda inna trasa API Notiondesk na swojej ścieżce.

W interfejsie API Notiondesk centrum pomocy nazywane jest witryną .

Wymień swoje centra pomocy

Lista zawiera wszystkie centra pomocy w obszarze roboczym, do których należy Twój klucz, najpierw najstarsze, przy użyciu numeracji kursora page_size i cursor.

curl "https://api.notiondesk.so/sites?page_size=50" \
  -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
}

Prowadzisz kilka centrów pomocy? Zobacz Tworzenie wielu centrów pomocy .

Przeczytaj konfigurację centrum pomocy

Odpowiedź opisuje centrum pomocy i wszystkie ustawienia, które API może zmienić. Przeczytaj ją ponownie po aktualizacji ustawień, aby potwierdzić nowy stan: ustawienia kierują odpowiedź 204 No Content bez treści.

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

{
  "id": "c74781f6-1aea-4e17-ab23-bbb8b4d174b6",
  "full_domain": "help.example.com",
  "enabled": true,
  "default_locale": "en",
  "access_mode": "public",
  "guest_access_requires_login": true,
  "supported_locales": ["en", "fr"],
  "available_locales": ["en", "fr", "de", "es"],
  "auto_sync_enabled": true,
  "seo_indexing_enabled": true,
  "setting_content_items": [
    {"locale": "en", "page_title": "Example Help Center", "page_description": "Answers about Example"}
  ],
  "auto_translate_enabled": false,
  "auto_translate_source_locale": null,
  "llms_txt_enabled": true,
  "markdown_export_enabled": true,
  "ai_contextual_menu_enabled": false,
  "mcp_search_enabled": true,
  "contact_form_enabled": true,
  "changelog_enabled": true,
  "changelog_email_subscriptions_enabled": false,
  "changelog_reactions_enabled": true,
  "changelog_email_subject_pattern": null,
  "changelog_categories": [
    {"category_id": "2984612035", "color": "blue_sky"}
  ]
}

Sprawdź status zaplanowanej synchronizacji

Odpowiedź jest taka sama, jak ta wyświetlana na pulpicie nawigacyjnym dla zaplanowanych synchronizacji:

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

{
  "auto_sync_enabled": true,
  "frequency": "daily",
  "next_sync_at": "2026-10-19T06:00:00+00:00",
  "current_status": "idle",
  "recent_runs": [
    {
      "started_at": "2026-10-18T06:00:02+00:00",
      "finished_at": "2026-10-18T06:01:41+00:00",
      "status": "success",
      "message": "Synced successfully.",
      "error_category": null,
      "requires_customer_action": false
    }
  ]
}

Każdy przebieg ma started_at, finished_at (null podczas przebiegu oraz dla przebiegu, który przekroczył limit czasu), status (in_progress, success lub failed), krótki message oraz dla przebiegu zakończonego niepowodzeniem:

Gdy requires_customer_action jest równe true, kolejne uruchomienie również zakończy się niepowodzeniem, dopóki nie naprawisz jakiegoś problemu, na przykład połączenia z Notion. Zobacz Jak zsynchronizować centrum pomocy z Notion .

Status synchronizacji zawiera tylko listę zaplanowanych uruchomień. Synchronizacja wyzwolona przez API lub pulpit nawigacyjny nie pojawia się w . Zobacz artykuł „Synchronizacja Trigger Notion z API Notiondesk”, aby potwierdzić wyzwoloną synchronizację.recent_runs

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?

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

• Trigger Notion synchronizuje się z API Notiondesk

• Zaktualizuj ustawienia centrum pomocy za pomocą interfejsu API Notiondesk