Zaktualizuj ustawienia centrum pomocy za pomocą interfejsu API Notiondesk

API Notiondesk umożliwia zmianę ustawień centrum pomocy z poziomu kodu: indeksowania w wyszukiwarkach, tytułu i opisu strony w każdym języku, optymalizacji AI, formularza kontaktowego i dziennika zmian. Można go używać do stosowania tej samej konfiguracji w kilku centrach pomocy lub do przechowywania ustawień w systemie kontroli wersji.

Języki i automatyczne tłumaczenie mają swój własny artykuł: Zarządzanie językami i automatycznym tłumaczeniem za pomocą interfejsu API Notiondesk . Kolory, czcionki i układ są dostępne w sekcji „Dostosuj branding i motywy w Centrum pomocy za pomocą interfejsu API Notiondesk” .

Jak działają aktualizacje ustawień

Każda trasa na tej stronie podlega tym samym zasadom:

• Wyślij tylko to, co zmienisz. Pole, które pominiesz, zachowa swoją obecną wartość.

• Odpowiedź to 204 No Content , bez treści, nawet gdy nic się nie zmieniło. Odczytaj nowy stan za pomocą GET /sites/{site_id}, zgodnie z opisem w sekcji „Odczytuj swoje centra pomocy za pomocą interfejsu API Notiondesk” .

• Wyślij wartości logiczne JSON. Tylko true lub false: wartości 0 i "false" są odczytywane jako true.

• Nieznane pola są odrzucane kodem 400 validation_error i nic się nie zmienia.

• Ponowne próby są bezpieczne dzięki Idempotency-Key. Zobacz Obsługa błędów API Notiondesk, limitów szybkości i ponownych prób .

Indeksowanie w wyszukiwarkach, tytuły i opisy stron

curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/content" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"seo_indexing_enabled": true, "items": [{"locale": "fr", "page_title": "Centre d aide Example", "page_description": "Toutes les réponses sur Example"}]}'

Każdy obiekt w items:

Obiekt zmienia tylko pola, które zawiera, a język pominięty w items zachowuje swój tytuł i opis. items nie może dodać ani usunąć języka.

Błąd w jednym z języków powoduje nadanie mu nazwy w ścieżce pola, na przykład items[fr].page_title.

seo_indexing_enabled: false Prosi wyszukiwarki o zaprzestanie indeksowania całego Centrum pomocy. Zobacz Zapobiegaj indeksowaniu i przeszukiwaniu Centrum pomocy przez wyszukiwarki .

Optymalizacja AI

curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/ai-optimization" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"llms_txt_enabled": true, "markdown_export_enabled": true, "ai_contextual_menu_enabled": true}'

Twój plan musi uwzględniać optymalizację AI. Dowiedz się, co robi każda funkcja w sekcji „Konfigurowanie optymalizacji AI” w Centrum pomocy oraz „Wprowadzenie do optymalizacji GEO/AI” .

Formularz kontaktowy

curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/contact-form" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"enabled": false}'

• API włącza lub wyłącza formularz, ale nic więcej. Adresy, na które przesyłane są zgłoszenia, są ustawiane w panelu. Treść z destination_emails odpowiada 400 validation_error i niczego nie zmienia.

• Formularz pozostaje aktywny tylko z zapisanym adresem. Włączenie go w centrum pomocy bez adresu powoduje błąd 400 validation_error dla destination_emails. Najpierw ustaw adres w panelu. Wyłączenie formularza nie wymaga adresu.

• Twój plan musi obejmować zaawansowaną personalizację, nawet możliwość wyłączenia formularza.

Dziennik zmian

curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/changelog" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"enabled": true, "reactions_enabled": true, "changelog_categories": [{"category_id": "2984612035", "color": "blue_sky"}]}'

Każdy obiekt w changelog_categories ma wymagany category_id, id jednej z Twoich kolekcji i opcjonalny color o długości do 255 znaków.

changelog_categories Zastępuje cały zestaw. Pominięta kolekcja przestaje być kolekcją rejestru zmian i usuwa je wszystkie. Czytaj od początku, gdy chcesz dodać tylko jedną. Zestaw może pomieścić do 100 kolekcji.[]changelog_categoriesGET /sites/{site_id}

Twój plan musi zawierać dziennik zmian. Jeśli subskrypcje e-mail są włączone, ale Twój plan nie obejmuje już powiadomień e-mail o dzienniku zmian, każde żądanie do tej trasy odpowiada kodem 403 permission_denied, aż do wysłania "email_subscriptions_enabled": false.

Więcej informacji znajdziesz w sekcji Konfigurowanie dzienników zmian w Centrum pomocy i Jak włączyć subskrypcje e-mailowe dla dzienników zmian .

Błędy

Zobacz temat Obsługa błędów API Notiondesk, limitów szybkości i ponownych prób, aby zapoznać się z obwiednią błędu i innymi kodami.

Często zadawane pytania

Co dalej?

• Dostosuj branding i motywy centrum pomocy za pomocą interfejsu API Notiondesk

• Zarządzaj integracjami centrum pomocy z interfejsem API Notiondesk

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