Spis treści 5 sekcji

Zendesk API pozwala połączyć Zendesk z systemami działu IT i wymieniać dane o zgłoszeniach pracowników. W artykule omawiamy planowanie takiego połączenia, uwierzytelnianie, diagnostykę automatyzacji oraz warunki dla twórców integracji.
Już na etapie planowania trzeba uwzględnić limit planu Zendesk Suite Professional: 400 żądań Support API na minutę1.

Czym jest Zendesk API w obsłudze danych i zgłoszeń IT?

System pracowniczy może przekazać przez Zendesk API zgłoszenie awarii sprzętu do działu IT. Dokumentacja Zendesk APIs obejmuje 7 obszarów: Ticketing, Help Center, Voice, Live Chat, Sales CRM, Custom Data i Conversations (Messaging)2. W Ticketing API zasób tickets przechowuje zgłoszenia, a users – dane użytkowników, w tym pracowników3.

Dział IT powinien zacząć od Ticketing, czyli obsługi zgłoszeń. Pozostałe obszary mają znaczenie zależnie od kanałów kontaktu i danych używanych przez pracowników. Przed połączeniem systemów trzeba ustalić, gdzie znajdują się źródłowe dane pracownika i jak rozpoznać tę samą sprawę po obu stronach.
Pole id nadaje zgłoszeniu Zendesk, a external_id pozwala powiązać je z identyfikatorem sprawy w systemie zewnętrznym4.

Tabela zestawia 7 obszarów dokumentacji Zendesk API: Ticketing, Help Center, Voice, Live Chat, Sales CRM, Custom Data i Conversations, wraz z rodzajami danych przydatnych w obsłudze pracowników2.

ObszarRodzaj danych lub kontaktuPrzykład w dziale IT
TicketingZgłoszeniaAwaria laptopa zgłoszona do helpdesku
Help CenterTreści pomocyInstrukcja konfiguracji dostępu
VoiceKontakt głosowyTelefon w sprawie blokady konta
Live ChatRozmowa na czacieKontakt podczas problemu z logowaniem
Sales CRMDane relacji sprzedażowychPowiązanie sprawy IT z danymi używanymi przez zespół sprzedaży
Custom DataDane niestandardoweOznaczenie urządzenia lub lokalizacji pracownika
Conversations (Messaging)WiadomościRozmowa o dostępie do aplikacji

Jak wysłać żądanie z systemu pracowniczego i odczytać odpowiedź API?

System pracowniczy wysyła przez Zendesk API żądanie dotyczące zgłoszenia, a odpowiedź wykorzystuje w dalszej obsłudze sprawy. Przy pomyślnym utworzeniu zgłoszenia żądaniem POST interfejs zwraca kod HTTP 201 Created3.

  • Cel żądania musi wskazywać określoną operację, na przykład odczyt zgłoszenia awarii. Do takiego odczytu system pracowniczy potrzebuje identyfikatora właściwej sprawy.
  • Żądanie HTTPS musi trafić pod adres interfejsu właściwy dla operacji i zawierać wymagane dane uwierzytelniające. Dane pracownika należy przesłać tylko wtedy, gdy operacja ich wymaga.
  • Odpowiedź API trzeba odczytać przed zapisaniem zmian w systemie pracowniczym. Integracja powinna osobno obsługiwać otrzymane dane, brak dostępu i niepowodzenie operacji.

System pracowniczy otrzymuje wynik określonej operacji. Samo wysłanie żądania nie dowodzi, że się powiodła.
Kod 201 potwierdza utworzenie zgłoszenia, natomiast 422 oznacza, że poprawne składniowo żądanie nie może zostać przetworzone5.

Jak powiązać zgłoszenia IT z użytkownikami i organizacjami?

Integracja musi konsekwentnie przypisywać zgłoszenie do pracownika i właściwej organizacji. Dzięki temu agent IT wie, kogo dotyczy sprawa. W zgłoszeniu pole requester_id wskazuje zgłaszającego, a organization_id – powiązaną z nim organizację4.

  • Pracownik powinien mieć jednoznaczny identyfikator używany przez integrację. Adres mailowy może pomóc w wyszukaniu osoby, ale po powiązaniu system powinien zachować identyfikator rekordu.
  • Organizacja powinna odpowiadać strukturze obsługi przyjętej w firmie, na przykład spółce albo jednostce organizacyjnej. Przy kolejnych zgłoszeniach tego pracownika integracja musi stosować tę samą regułę przypisania.
  • Powiązanie zgłoszenia trzeba zapisać po utworzeniu sprawy. Zachowany identyfikator pozwoli później zaktualizować zgłoszenie bez tworzenia kolejnego dla tej samej awarii.

Stałe identyfikatory wiążą historię obsługi IT z właściwym pracownikiem. To ważne także przy kolejnych sprawach tej osoby.
Wartość external_id użytkownika musi być unikalna w ramach konta Zendesk, co pomaga utrzymać to powiązanie6.

Jak prowadzić zgłoszenie od utworzenia do zamknięcia przez integrację?

Zendesk API może obsługiwać cały cykl życia zgłoszenia IT. Integracja musi przy tym zachować identyfikator sprawy i synchronizować zmiany jej stanu. Może uwzględniać 6 standardowych statusów: new, open, pending, hold, solved i closed; dostępność hold zależy od konfiguracji konta4.

  • Utworzenie zgłoszenia powinno przekazać opis problemu i dane osoby zgłaszającej. System źródłowy musi następnie zapisać otrzymany identyfikator sprawy.
  • Aktualizacja zgłoszenia powinna korzystać z zapisanego identyfikatora. Informacje o wykonanych czynnościach pomagają agentowi odtworzyć przebieg naprawy.
  • Zamknięcie zgłoszenia powinno przebiegać zgodnie z procesem obsługi IT przyjętym w firmie. Integracja musi odnotować końcowy stan również w systemie pracowniczym.

Wspólny identyfikator zachowuje ciągłość obsługi od zgłoszenia problemu do zakończenia sprawy. Przy zmianie stanu znaczenie ma także możliwość powrotu do pracy nad zgłoszeniem.
Zgłoszenie solved można ponownie otworzyć, lecz zgłoszenia closed nie można już otworzyć ponownie7.

Jak stronicować i filtrować dane na potrzeby działu IT?

Zendesk API pozwala pobierać dane partiami i ograniczać odczyt do spraw potrzebnych działowi IT8. Ma to znaczenie, gdy integracja regularnie odświeża zgłoszenia. Zakres pobieranych danych warto więc ustalić przed uruchomieniem synchronizacji.

  • Filtr danych powinien wynikać z zadania integracji, na przykład obejmować sprawy obsługiwane przez IT. Osobne zapytania mogą pobierać bieżące zgłoszenia i sprawy archiwalne.
  • Stronicowanie oznacza pobieranie kolejnych części wyniku, a nie uznanie pierwszej odpowiedzi za całą listę. Integracja powinna przechodzić między stronami w sposób przewidziany dla wybranego żądania.
  • Synchronizacja musi zapamiętać punkt, od którego wznowi odczyt po przerwie. Przed ponownym zapisaniem rekordu system powinien rozpoznać, czy sprawę już przetworzył.

Filtr wyznacza sprawy potrzebne integracji, a stronicowanie pozwala odebrać cały wybrany zbiór. Oba mechanizmy pełnią więc różne zadania.
Przy stronicowaniu kursorem parametr page[size] określa wielkość strony; większość punktów końcowych dopuszcza maksymalnie 100 rekordów9.

Uwierzytelnianie i diagnostyka Zendesk API w dziale IT

Metodę uwierzytelniania trzeba dobrać do sposobu działania integracji. Dział IT powinien osobno diagnozować dane logowania, uprawnienia konta, treść żądania i tempo automatyzacji. Odpowiedź na każde żądanie pomaga ustalić, gdzie wystąpił problem.
Token API działa jak hasło przesyłane z danymi konta, natomiast OAuth 2.0 używa tokenu dostępu i jest metodą zalecaną przez Zendesk10.

Użytkownik społeczności Zendesk twierdzi, że tokeny API nie są przypisywane do konkretnego użytkownika ani ograniczane zakresem uprawnień. To relacja użytkownika, nie reguła bezpieczeństwa potwierdzona dokumentacją produktu11. W tej samej dyskusji opisano zalecenie przedstawiciela Zendesk, by po rozważeniu OAuth korzystać z tokenów API; dotyczyło ono omawianego tam przypadku11.

Tabela porównuje zadania działu IT przy wdrażaniu obu metod uwierzytelniania.

MetodaZadanie działu IT
Token APIUstalić, kto przechowuje sekret i może używać go w integracji, oraz ograniczyć dostęp do sekretu w systemie pracowniczym.
OAuthZaplanować uzyskiwanie i odnawianie dostępu oraz ocenić tę metodę w kontekście własnej integracji, zamiast przenosić zalecenie z cudzego przypadku.

Jak odróżnić problem z uprawnieniami od błędnych danych w żądaniu?

Odpowiedź Zendesk API trzeba zestawić z wysłanym żądaniem i kontem używanym przez integrację. W diagnostyce 401 wskazuje problem uwierzytelniania, 403 brak uprawnień, 422 nieprzetwarzalne dane żądania, a 429 przekroczenie limitu żądań12. Każdy z tych przypadków wymaga sprawdzenia innej części połączenia.

  • Dane uwierzytelniające wymagają sprawdzenia sekretu i sposobu przekazania go w żądaniu13.
  • Uprawnienia konta trzeba porównać z operacją wykonywaną przez integrację. Możliwość odczytania sprawy nie oznacza automatycznie prawa do jej zmiany.
  • Dane żądania należy sprawdzić względem wymagań wybranej operacji. Dotyczy to między innymi identyfikatora zgłoszenia i nazw pól.

Oddzielne sprawdzenie tych przyczyn pomaga uniknąć zmiany uprawnień, gdy poprawy wymaga samo żądanie. Nie daje jednak gwarancji, że taka zmiana nigdy nie będzie potrzebna13.

Dlaczego automatyzacja IT może przekroczyć limit żądań?

Zendesk API może otrzymać zbyt wiele żądań, gdy jednocześnie działają synchronizacja pracowników, odczyt zgłoszeń i ponawianie nieudanych operacji. W planie Zendesk Suite Team limit Support API i Help Center API wynosi 200 żądań na minutę.
Po jego przekroczeniu interfejs zwraca odpowiedź 4291.

Automatyzacja IT powinna ograniczać równoległe odczyty i pobierać tylko potrzebne dane. Po sygnale przekroczenia limitu musi też wstrzymać ponawianie żądań. Niekontrolowane próby zwiększają ruch zamiast przywracać synchronizację14.

Jak przetestować połączenie i dane uwierzytelniające przed uruchomieniem integracji?

Połączenie z Zendesk API warto najpierw sprawdzić operacją odczytu. Dopiero po takim teście system pracowniczy powinien zacząć tworzyć lub zmieniać zgłoszenia. Poprawnie uwierzytelnione żądanie GET /api/v2/users/me.json powinno zwrócić kod HTTP 200 i dane użytkownika6.

  • Połączenie należy sprawdzić żądaniem HTTPS wysłanym ze środowiska, w którym będzie działać integracja.
  • Uwierzytelnianie trzeba zweryfikować metodą i danymi dostępu przeznaczonymi dla uruchamianego połączenia.
  • Odpowiedź należy zapisać razem ze statusem i komunikatem błędu. Tokeny i inne sekrety nie powinny trafiać do dziennika.
  • Uprawnienia trzeba przetestować na operacji odpowiadającej zadaniom integracji. Przy zmianach w rzeczywistych zgłoszeniach należy zachować ostrożność.

Test powinien potwierdzić dostęp do właściwych danych oraz obsługę błędnych odpowiedzi. Samo nawiązanie połączenia nie wystarczy.
Sprawdź odpowiedź 200 dla poprawnego odczytu i rozróżniaj 401 przy błędnym uwierzytelnianiu oraz 403 przy braku uprawnień15.

Warunki prawne dla twórców integracji z Zendesk

Korzystanie z Zendesk API podlega Zendesk Developer Terms oraz zasadom zmian interfejsu – Change policy2. Warunki deweloperskie dotyczą używania API. Zasady zmian mają z kolei znaczenie przy utrzymywaniu połączenia z systemem pracowniczym.

Dział IT powinien uwzględnić oba dokumenty, ustalając odpowiedzialność za rozwój i utrzymanie integracji. Zgodność obejmuje sposób korzystania z API oraz reagowanie na zmiany interfejsu.

Najczęściej zadawane pytania

Czy Zendesk ma API?

Tak. Zendesk API umożliwia połączenie Zendesk z systemami działu IT i wymianę danych o zgłoszeniach pracowników.

Czy dział IT musi korzystać ze wszystkich obszarów Zendesk API?

Nie. Zależnie od kanałów kontaktu i używanych danych dział IT może zacząć od Ticketing, a pozostałe obszary uwzględnić wtedy, gdy są potrzebne.

Czy status hold jest dostępny na każdym koncie Zendesk?

Nie zawsze — jego dostępność zależy od konfiguracji konta.

Czy zgłoszenie ze statusem closed można ponownie otworzyć?

Nie. Ponownie otworzyć można zgłoszenie solved, ale closed nie można już otworzyć.

Źródła

  1. ↑Zendesk Developer Docs: Rate limits ([developer.zendesk.com](developer.zendesk.com https://developer.zendesk.com/api-reference/introduction/rate-limits/
  2. ↑Introduction https://developer.zendesk.com/api-reference/introduction/introduction/
  3. ↑Zendesk Developer Docs — Ticketing https://developer.zendesk.com/api-reference/ticketing/introduction/
  4. ↑Zendesk Developer Docs — Tickets https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/
  5. ↑Zendesk Developer Docs — Requests https://developer.zendesk.com/api-reference/introduction/requests/
  6. ↑Zendesk Developer Docs — Users https://developer.zendesk.com/api-reference/ticketing/users/users/
  7. ↑Zendesk help — About the ticket lifecycle and ticket statuses https://support.zendesk.com/hc/en-us/articles/8263915942938-About-the-ticket-lifecycle-and-ticket-statuses
  8. ↑Zendesk Developer Docs: Search ([developer.zendesk.com](developer.zendesk.com https://developer.zendesk.com/api-reference/ticketing/ticket-management/search/
  9. ↑Zendesk Developer Docs — Pagination https://developer.zendesk.com/api-reference/introduction/pagination/
  10. ↑Zendesk Developer Docs — Security and authentication https://developer.zendesk.com/api-reference/introduction/security-and-auth/
  11. ↑Zendesk APIs – Token Security | The place for Zendesk users to come together and share https://community.zendesk.com/platform-and-developer-18/zendesk-apis-token-security-9384
  12. ↑Zendesk Developer Docs — Errors https://developer.zendesk.com/api-reference/sales-crm/errors/
  13. ↑Zendesk help: Troubleshooting 401 and 403 Errors on the Zendesk Developer Platform ([support.zendesk.com](support.zendesk.com https://support.zendesk.com/hc/en-us/articles/10306782115610-Troubleshooting-401-and-403-Errors-on-the-Zendesk-Developer-Platform
  14. ↑Zendesk Developer Docs: Best practices for avoiding rate limiting ([developer.zendesk.com](developer.zendesk.com https://developer.zendesk.com/documentation/api-basics/best-practices/best-practices-for-avoiding-rate-limiting/
  15. ↑Zendesk Developer Docs — Access Logs https://developer.zendesk.com/api-reference/ticketing/account-configuration/access_logs/

Ceny i warunki sprawdzone u źródeł: październik 2026.