Subskrypcja Advanced Integrated Visibility oparta na numerze monitorowania została opracowana z myślą o subskrybentach usługi Advanced Integrated Visibility, aby umożliwić im zarządzanie projektami elementu webhook opartymi na numerze przesyłki w ramach tej subskrypcji i wykonywanie takich operacji projektowych jak dodawanie nowych numerów przesyłki oraz edycja i podgląd szczegółów zadań za pomocą punktów końcowych API.

Uwaga:

• Projekt Advanced Integrated Visibility wymaga uprawnień na poziomie administratora lub współautora.
• Więcej informacji o usłudze Advanced Integrated Visibility i jej funkcjach znajdziesz na stronie Dokumentacja usługi Advanced Integrated Visibility.

Subskrypcja Advanced Integrated Visibility oparta na numerze monitorowania zapewnia następujące korzyści:

• Możesz łatwo aktualizować numery monitorowania w swoim projekcie Advanced Integrated Visibility i zarządzać nimi za pomocą punktów końcowych interfejsu API.
• Interfejs API umożliwia powiązanie wielu numerów monitorowania z projektem w ramach jednej transakcji API zamiast wybierania każdego numeru po kolei.
• Możesz przesyłać żądania API jedno po drugim oraz przeglądać szczegółowe dzienniki dotyczące powodzenia lub niepowodzenia tych żądań.

Projektem Advanced Integrated Visibility można zarządzać za pomocą tych punktów końcowych:

Ten interfejs API jest dostępny tylko w ramach podsumowania projektu, jak pokazano na zrzucie ekranu powyżej.

Użyj tego punktu końcowego, aby uruchomić asynchroniczne zadanie polegające na powiązaniu jednego lub kilku numerów monitorowania z określonym projektem Advanced Integrated Visibility.

Wymagane informacje wejściowe związane z tym żądaniem to:

• Działanie — określ, jakie działanie ma zostać wykonane podczas wysyłania żądania. Na przykład: DODAJ.
• Szczegóły numeru monitorowania — podaj numer monitorowania.

W jednym żądaniu możesz powiązać maksymalnie 1000 numerów monitorowania. Pomyślna odpowiedź na żądanie zwróci identyfikator zadania (jobID), bieżący status zadania oraz sygnatury czasowe utworzenia i zakończenia zadania. Identyfikator jobID można wykorzystać później do sprawdzenia statusu zadania asynchronicznego.

Użyj tego punktu końcowego, aby sprawdzić status zadania asynchronicznego (jednego lub kilku kolejnych żądań w kolejce) albo status wszystkich przesłanych zadań.

Wymagane informacje wejściowe związane z tym żądaniem to:

• ID zadania — podaj identyfikator zadania, którego status chcesz sprawdzić.

Uwaga: ID zadania jest opcjonalnym parametrem dla tego punktu końcowego. Jeśli go nie podasz, pobrany zostanie status wszystkich przesłanych zadań.

Pomyślna odpowiedź na żądanie zwróci identyfikator zadania (jobID), bieżący status zadania oraz sygnatury czasowe utworzenia i zakończenia zadania. Odpowiedź będzie wskazywać aktualny status zadań. Odpowiedź będzie też zawierać komunikaty o sukcesie, błędy oraz ostrzeżenia. Użytkownicy mogą je przeglądać i w razie potrzeby rozwiązywać występujące problemy.

• Jeśli status zadania jest wyświetlany jako COMPLETED (Ukończone), oznacza to, że wszystkie numery monitorowania zostały zweryfikowane i przetworzone.
  • Status ten wskazuje, że numery monitorowania zostały zweryfikowane i przetworzone. Nie oznacza to jednak, że wszystkie numery monitorowania zostały pomyślnie dodane do projektu Advanced Integrated Visibility.
  • Jeśli spróbujesz powiązać wiele numerów monitorowania, ale zostanie to wykonane tylko w przypadku niektórych z nich, status zadania i tak zostanie zmieniony na COMPLETED. Aby sprawdzić status każdego numeru monitorowania w żądaniu powiązania, należy pobrać raport zbiorczy.

Uwaga:

• Jeśli zadanie ma status FAILED (Niepowodzenie), oznacza to, że z różnych powodów lub wskutek poważnych błędów żądanie nie mogło zostać przetworzone i użytkownik musi je ponowić.

Oto lista statusów wraz z opisami:

Ten punkt końcowy umożliwia pobranie raportu JSON dotyczącego zadania asynchronicznego mającego status COMPLETED.

Wymagane informacje wejściowe związane z tym żądaniem to:

• ID zadania — podaj identyfikator zadania, którego status chcesz sprawdzić.

Uwaga:

• W przypadku tego punktu końcowego identyfikator zadania jest obowiązkowy.
• Naraz można pobrać raport dotyczący tylko jednego zadania asynchronicznego.
• Jeśli zadanie nie ma statusu COMPLETED i spróbujesz pobrać raport, pojawi się komunikat o błędzie.

Pomyślna odpowiedź na żądanie powoduje dostarczenie raportu dotyczącego zadania w formacie JSON.

• W każdym żądaniu z projektem Advanced Integrated Visibility można powiązać maksymalnie 1000 numerów monitorowania.
• Nie ma ograniczeń co do maksymalnej liczby numerów monitorowania, które można powiązać z wybranym projektem Advanced Integrated Visibility.
• Po 40 dniach każdy powiązany numer monitorowania zostanie usunięty z danego projektu Advanced Integrated Visibility.
• Status i szczegóły utworzonego identyfikatora zadania w danym projekcie Advanced Integrated Visibility przestaną być dostępne po 90 dniach.
• Zabezpieczone informacje dotyczące monitorowania, takie jak adres lub podpis odbiorcy, nie będą dostępne w ramach subskrypcji Advanced Integrated Visibility opartej na numerze monitorowania.