Przejdź do treści

API

Podręcznik Mint Service Desk 3.4.2: instalacja, administracja oraz praca agentów i klientów.

API

W tej sekcji możesz przeglądać, tworzyć, edytować i usuwać klientów API Mint Service Desk.

Aby utworzyć klienta API, kliknij przycisk obok wyszukiwania po prawej stronie. Otworzy się formularz wymaganych danych.

Uzupełnij:

  • Client ID: identyfikator klienta API.
  • Nazwa klienta: nazwa klienta API.

Wybierz też dozwolone zakresy, określające zestawy punktów końcowych dostępnych dla klienta API.

Mint Service Desk udostępnia trzy zakresy:

  • mint_api.assets: przeglądanie i edycja zasobów MINT Service Desk.
  • mint_api.tickets: przeglądanie informacji o zgłoszeniach, dodawanie komentarzy i inne zmiany.
  • mint_api.user_restricted (Require user): rozszerza powyższe zakresy o działania wymagające użytkownika, między innymi tworzenie zgłoszeń i dodawanie artykułów.

Po wybraniu zakresu zasobów lub zgłoszeń zapisz klienta API przyciskiem .

Powiązane artykuły

Wykonanie żądania

Tworzenie klienta API

Przed wykonaniem żądania przygotuj klienta API przyciskiem .

Klient umożliwia komunikację maszyna–maszyna. Za pomocą client_id i client_secret można uwierzytelnić się w MINT i wykonywać żądania.

  • Client ID: bez spacji; można użyć podkreślenia.
  • Nazwa klienta.
  • Dozwolone zakresy: w tym przykładzie skupiamy się na zasobach i zgłoszeniach: mint.api_assets oraz mint_api.tickets.

Zakres określa obszar dostępny integracji przez wygenerowany token.

Po dodaniu zakresów i kliknięciu zostanie wygenerowany sekret klienta. Skopiuj go i zachowaj. Ponowne wygenerowanie sekretu unieważnia poprzedni.

Uzyskanie tokenu

Do pobrania tokenu użyjemy Postmana. Utwórz żądanie POST na adres swojej instancji Mint z końcówką /connect/token, na przykład https://rcmintsd.opgksoftware.com/connect/token.

Uzupełnij cztery pola:

  • grant_type: client_credentials.
  • client_id: identyfikator podany podczas konfiguracji API.
  • client_secret: sekret otrzymany po konfiguracji klienta API.
  • scope: zakresy wskazane w konfiguracji API.

Użyj formatu x-www-form-urlencoded.

Kliknij „Send”, aby otrzymać token.

Testowanie żądania

Skopiuj token. Możesz sprawdzić go pod adresem your_address_to_mint/swagger/index.html.

Kliknij przycisk i wpisz w polu „Bearer your_token”.

Następnie ponownie kliknij przycisk .

Aby sprawdzić token, przejdź do sekcji zgłoszeń i wybierz /api/Tickets/{ticketId}. Zobaczysz przykład odpowiedzi. Kliknij , wpisz identyfikator zgłoszenia w polu ticketid i wykonaj żądanie przyciskiem Execute.

To samo można sprawdzić w Postmanie, wybierając GET i adres page_address/api/Tickets/{ticketId}, na przykład https://rcmintsd.opgksoftware.com/api/Tickets/{ticketId}.

Tworzenie użytkownika bota

Zakres dostępu i konto bota

Podczas tworzenia klienta API można wybrać trzeci zakres: mint_api.user_restricted (Require user).

Wymaga to utworzenia użytkownika bota. Żądania wymagające użytkownika będą wykonywane w imieniu tego konta.

Po wybraniu zakresu pojawi się sekcja tworzenia użytkownika bota.

Podaj poprawny adres e-mail, imię i nazwisko. Kliknij przycisk . Otworzy się okno jednorazowo wyświetlanego sekretu.

Zapis sekretu

Sekret jest domyślnie ukryty. Odsłoń go ikoną i zachowaj. Możesz też skopiować go do schowka przyciskiem , a następnie wkleić w wybranym miejscu, na przykład edytorze tekstu.

Sekret jest kluczem zarejestrowanym dla usługi wykonującej wywołania.

Po zachowaniu sekretu kliknij , aby utworzyć klienta API wraz z użytkownikiem bota.

Zarządzanie klientem API

Klienta API można później edytować przyciskiem lub usunąć przyciskiem .

Podczas edycji po prawej stronie znajduje się sekcja sekretów z ich listą.

Przycisk generuje nowy sekret. Skopiuj i zachowaj go tak jak przy tworzeniu bota.

Aby usunąć sekret, najedź na jego pozycję i kliknij pojawiający się przycisk .