Zarządzaj integracjami centrum pomocy z interfejsem API Notiondesk

API Notiondesk umożliwia wyświetlanie, konfigurowanie i wyłączanie integracji z usługami zewnętrznymi Twojego centrum pomocy: analityką, czatem na żywo i dostawcami menedżera tagów. Użyj go, aby wdrożyć tę samą konfigurację analityki lub czatu w kilku centrach pomocy za pomocą jednego skryptu.

Konfigurowanie i wyłączanie dostawców wymaga planu obejmującego integracje.

Każdy dostawca ładuje skrypt innej firmy na każdej stronie centrum pomocy. Kontener Menedżera tagów Google uruchamia wszystko, co publikuje jego właściciel, a Plausible lub Umami decyduje, skąd pobierany jest skrypt analityczny. Dlatego zmiana integracji wymaga określonego zakresu. Klucz należy podawać tylko integracjom, którym ufasz.proxy_urladminadmin

Obsługiwani dostawcy

Każda wartość to ciąg znaków o długości do 255 znaków. Żadna z nich nie jest tajna: każda to identyfikator, którego skrypt dostawcy potrzebuje na stronie. Notiondesk sprawdza format u dostawcy, ale nie sam identyfikator.

Wypisz swoje integracje

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

{
  "object": "list",
  "data": [
    {
      "type": "plausible-analytics",
      "settings": {"domain": "help.example.com", "proxy_url": null},
      "enabled": true
    },
    {
      "type": "crisp",
      "settings": {"app_id": "7d1c9a2e-5b4f-4e3a-9c8d-2f1e0a9b8c7d"},
      "enabled": false
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Lista zawiera dostawców, którzy są wyłączeni, w dowolnej kolejności i zawsze mieszczą się w jednej odpowiedzi. Brakuje dostawcy, który nigdy nie został skonfigurowany.

Skonfiguruj dostawcę

Wyślij pola dostawcy do jego ścieżki. Trasa odpowiada 200 OK z integracją.

curl -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations/plausible-analytics" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"domain": "help.example.com"}'

{
  "type": "plausible-analytics",
  "settings": {"domain": "help.example.com", "proxy_url": null},
  "enabled": true
}

• Aktualizacja zawsze włącza dostawcę. Brak pola enabled: aby wyłączyć dostawcę, należy użyć ścieżki „disable”.

• Pominięte pole zachowuje swoją zapisaną wartość. Aby ponownie włączyć skonfigurowanego dostawcę bez zmiany, wyślij polecenie {}.

• Aby usunąć serwer proxy, wyślij "proxy_url": null.

• Każda aktualizacja odświeża całe centrum pomocy, czyści jego buforowane strony i tworzy od nowa wszystkie strony.

Uwaga: Wartość zapisana przed zastosowaniem bieżących formatów, taka jak identyfikator Google Analytics lub inna niż , nie przejdzie walidacji. Dopóki nie wyślesz prawidłowej wartości dla tego pola, każda aktualizacja tego dostawcy będzie odpowiadać 400 włącznie.UA-proxy_urlhttpsvalidation_error{}

Wyłącz dostawcę

Trasa odpowiada 204 No Content, a centrum pomocy przestaje ładować dostawcę. Jej ustawienia zostają zachowane, więc lista nadal wyświetla ją z enabled: false, a {} wysłany do jej trasy aktualizacji ponownie ją włącza.

Wyłączenie dostawcy, który jest już wyłączony lub nigdy nie był konfigurowany, również odpowiada na błąd 204 i niczego nie zmienia, więc ponowna próba jest zawsze bezpieczna.

Błędy

curl -i -X POST "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations/google-tag-manager/disable" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

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?

• Uzyskaj analizę centrum pomocy za pomocą interfejsu API Notiondesk

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

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