Dla: Administratorzy
Zrozum, co może zrobić API
Dowiedz się, do czego służy klucz zarządzający i klucz centralny, dlaczego każdy klucz pełni funkcję wirtualnego asystenta i gdzie znajduje się pełna lista danych technicznych.
W tym artykule2 sekcji
API umożliwia swojemu oprogramowaniu, np. systemowi zarządzania sprawami, pracę z urządzeniem „hub”, bez konieczności korzystania z ekranów. API obsługuje klucz APIKlawisz Tajny token, stworzony w ramach integracji, który umożliwia Twojemu oprogramowaniu korzystanie z API centrum.. Istnieją dwa rodzaje takich kluczy: klucz do zarządzania panelem administracyjnym, który służy do zarządzania sprawami i osobami, oraz klucz do obsługi działań w ramach poszczególnych spraw.
Jak to działa
Dwa klucze, dwa API-y. Każdy z tych kluczy wywołuje swój własny adres, po którym następuje identyfikator twojego hubu. Ten adres jest odrzucany przez drugi klucz.
| Klawisz | Adres | Do czego to dotrze |
|---|---|---|
| Zarządzanie kluczowymi elementami | https://prd-api-manage.caseactive.com/v1/<hub id>/ | Są to przypadki, osoby za którymi tępi się dane, ich uprawnienia, role, etapy postępowania, informacje dotyczące wyszukiwania i faktury do odczytania. Importy odbywają się w miejscu https://prd-api-manage.caseactive.com/v1/integration/<hub id>/. |
| Klucz do urządzenia | https://prd-api-app.caseactive.com/v1/<hub id>/ | Wszystko w obrębie każdego przypadku: posty i komentarze, pliki, formularze, elektroniczne elementy, zadania, faktury, wydarzenia, notatki oraz szczegóły danego przypadku. |
Co za fajne funkcje, jakie oferuje ten klucz! Tylko te. Wszystkie inne próby skontaktowania się za pośrednictwem API w panelu administracyjnym powodują błąd 403. BotNotAllowedException.
- Poznaczenia: lista, tworzenie, czytanie, aktualizowanie i usuwanie. Zobacz Tworzenie i aktualizowanie poznań za pomocą narzędzia do zarządzania poznaniami.
- Członkowie przypadków: listowanie, dodawanie i usuwanie. Zobacz „Dodawanie i usuwanie członków przypadków za pomocą klawisza manage”.
- Ludzie: można ich dodać, odczytywać informacje o nich, a także wyłączać lub ponownie włączać je do funkcji systemu. Zobacz „Dodawanie i aktualizacja użytkowników za pomocą klawisza zarządzania”.
- Rola i etapy: proszę przeczytać informacje na stronie „Rola administratora”.
- Pole dostępne podczas tworzenia danych: prosimy o zapoznanie się z stronami zawierającymi informacje o przypadku i użytkowniku. Tworzyć i aktualizować dane dotyczące spraw. Związane z tym zarządzanie kluczami..
- Faktury: należy je przeczytać. Zobacz informacje w sekcji „Przeczytaj faktury za pomocą przycisku ‘Manage’”.
- Szukaj. Zobacz Szukanie przypadków i użytkowników z klawiszem zarządzania.
- Importy. Zobacz Jak uruchomić import za pomocą klawisza ‘manage’.
Każda klawiatura jest w rzeczywistości twoim asystentem wirtualnym. Kluczowe znaki dotyczące twojego centrum. Wirtualny asystentAsystent wirtualny Automatyczny członek zespołu, który publikuje wiadomości powitalne, meldunki i wpisy dotyczące etapów rozwoju firmy. Jego wpisy są oznaczone odznaką wirtualnego asystenta.. To, co jest publikowane pod nazwą Wirtualnej Asystentki oraz jej identyfikatorem, jest zapisane jako dane Wirtualnej Asystentki. Wirtualna Asystentka jest obecna w każdym przypadku, więc klucz centralny umożliwia dostęp do wszystkich danych w tej centrali. Wirtualna Asystentka może robić to, co pozwala jej na to jej rola – co w przypadku standardowych pracowników jest również możliwe. Przypadki zamknięte są dostępne tylko dla Wirtualnej Asystentki. Klucz centralny nie może tworzyć przypadków, dodawać lub usuwać osób, płacić faktury, ani otwierać lub odpowiadać na pytania.
Klucze nie wygasają z upływem czasu. To są kluczowe elementy, które muszą zostać usunięte przez administratora, jeśli nie chce, aby te dane zostały utracone. Limituj tylko te elementy do publicznej adresu IPv4 systemu twojego komputera. Zakazować lub odwołać klucz API.
Gatunki techniczne. Każdy API publikuje pełny opis swoich funkcji, bez konieczności logowania się.
| Zarządzaj kluczem | Klucz piasty | |
|---|---|---|
| Interaktywna (Swagger UI) | https://prd-api-manage.caseactive.com/ | https://prd-api-app.caseactive.com/ |
| Referencja (ReDoc) | https://prd-api-manage.caseactive.com/redoc | https://prd-api-app.caseactive.com/redoc |
| Dokument OpenAPI | https://prd-api-manage.caseactive.com/openapi.json | https://prd-api-app.caseactive.com/openapi.json |
Wyświetlają listę wszystkich połączeń, które same aplikacje wysyłają. W tym liście znajdują się również połączenia, których nie może obsłużyć żaden klucz. Wyższy list pokazuje, jakie funkcje może wykonywać dany klucz. Aby sprawdzić połączenie na stronie interaktywnej, wybierz Autoryzuj i wklej swój klucz.
Zamknięty hub. Gdy panel administracyjny hubu jest zamknięty po nieudanej transakcji płatności, próba uzyskania dostępu do danych zostaje odrzucona z powodu błędu 403 ManageBillingInactiveException. Klucz hubu nadal działa, ale dostęp do danych jest tylko w czasie pisemnym: 14 dni po nieudanej transakcji, jeśli płatność nadal nie została uzupełniona, lub w dniu wygaśnięcia anulowanej subskrypcji. Od tego momentu klucz hubu nadal może być używany, ale każda zmiana do danych zostaje odrzucona z powodu błędu 403 BillingReadOnlyException, dopóki administrator nie ponownie uruchomi subskrypcję.
Kiedy go używać
Użyj klucza do zarządzania, aby utrzymać swoje narzędzie w sposób zgodny z innymi systemami: tworzenie spraw, dodawanie klientów i umieszczanie ich w odpowiednich sprawach, odebranie dostępu do danych dla osób, które opuszczają system, lub ładowanie wielu danych z pliku jednocześnie. Użyj też klucza do zarządzania, aby móc pracować wewnątrz spraw za pomocą własnego oprogramowania – np. dodawanie informacji o zmianach w systemie.
Aby dowiedzieć się o zmianach w swoim serwerze, gdy one się zachodzą, a nie po prostu prosić o nie, użyj webhooka. Zobacz informacje na temat ustawienia webhooka w sekcji Ustawienie webhooka. Aby utworzyć klucz API, zobacz informacje na temat tworzenia klucza API w sekcji Tworzenie klucza API.