ID dokumentu: KB-EV4-API-01 | Produkt/Usługa: EloView 4 REST API | Odbiorcy: Integratorzy, Programiści, Klienci korporacyjni
Limity przetwarzania i najlepsze praktyki integracji o wysokim wolumenie w API EloView 4
REST API EloView umożliwia klientom korporacyjnym i partnerom integracyjnym programowe pobieranie informacji o urządzeniu, monitorowanie stanu floty, zarządzanie treścią i wdrażanie aplikacji. Artykuł ten przedstawia limity API EloView 4, zachowanie uwierzytelniania oraz najlepsze praktyki architektoniczne dla niezawodnych, dużych integracji API.
💡 Szybki przegląd
EloView 4 nie stosuje indywidualnych limitów API dla poszczególnych klientów. Dla optymalnej niezawodności integracje powinny pamiętać tokeny OAuth, preferować masowe/zgrupowane zapytania, ograniczać równoczesne wątki oraz stosować strategię wykładniczego opóźnienia z jitterem do obsługi błędów.
1. Limity API EloView 4
EloView 4 nie narzuca limitów na podstawie indywidualnych poświadczeń OAuth, konta klienta, adresu IP źródłowego ani punktu końcowego API. Bazowy adres URL produkcyjnego API to:
https://secure-api.eloview.com
| Parametr | Limit / Pojemność |
|---|---|
| Na poświadczenie, konto, IP źródłowe lub punkt końcowy | Nie zastosowano specyficznych limitów. |
| Wskaźnik żądań platformy AWS (dzielony) | 10 000 żądań/sekundę (dzielony globalnie przez wszystkich klientów). |
| Pojemność burst platformy AWS (dzielona) | 5 000 żądań (dzielone globalnie przez wszystkich klientów). |
⚠️ Krytyczne ostrzeżenie dotyczące integracji
Wskazane powyżej ograniczenia platformy są nie zarezerwowanymi kwotami dla poszczególnych klientów. Aby uniknąć problemów z wydajnością i chronić stabilność platformy, integracje muszą być zaprojektowane w sposób efektywny i odpowiedzialny w zakresie wykorzystania zasobów.
2. Uwierzytelnianie OAuth i zarządzanie tokenami
Nieprawidłowe zarządzanie tokenami jest powszechną przyczyną zbędnych obciążeń API. Proszę strukturalizować swoją logikę uwierzytelniania zgodnie z następującymi zasadami:
-
Czas życia tokena: Tokeny dostępu są ważne przez 24 godziny (
expires_in = 86400). - Pamięć podręczna i ponowne użycie: Pamiętaj i ponownie używaj tokenów dostępu przez cały ich czas życia. Nie generuj nowego tokena dla każdego żądania API.
-
Proaktywne odnawianie: Odnów pamiętany token krótko przed wygaśnięciem lub natychmiast po otrzymaniu odpowiedzi
HTTP 401 Unauthorized. - Poświadczenia a pojemność: Chociaż administratorzy konta mogą tworzyć wiele poświadczeń OAuth, wykorzystanie wielu poświadczeń nie zwiększa ogólnej pojemności API.
3. Monitorowanie floty i statusu urządzeń
Podczas monitorowania zdrowia urządzeń i aktywnych wdrożeń na dużą skalę, optymalizuj projekt zapytań, aby zredukować obciążenia sieci:
-
Rutynowe audyty statusu: Używaj punktów końcowych zapytań masowych—takich jak
GET /deviceslubPUT /devices/search—aby pobrać rekordy statusu dla wielu urządzeń w jednym wywołaniu. Unikaj pollingGET /devices/{serial}indywidualnie dla każdego kiosku. - Interwały pollingu (idle): Dla rutynowych kontroli zdrowia i statusu, interwały pollingu co kilka minut są wystarczające.
-
Monitorowanie aktywnego wdrożenia: Aby śledzić aktywne instalacje, zapytaj
GET /device/{serial}/content/statusz interwałem wynoszącym 1 do 2 minut. Zatrzymaj polling, gdy wdrożenie osiągnie ostateczny stan (Sukces lub Niepowodzenie).
4. Wdrażanie aplikacji na wiele urządzeń
Punkt końcowy POST /deployments wspiera celowanie w wiele urządzeń jednocześnie.
- Formaty celowania: Określ odbiorców w pojedynczym ładunku zapytania, używając listy numerów seryjnych, grup urządzeń lub kryteriów zapytania.
- Pusta celowa zapytanie: Pozostawienie pustego zapytania docelowego automatycznie celuje w wszystkie urządzenia w koncie. Używaj tego parametru z ekstremalną ostrożnością.
- Ograniczenia partii: Chociaż punkt końcowy nie narzuca sztywnego limitu numerów seryjnych, ładunki pozostają zależne od ustawień rozmiaru partii w Twoim koncie oraz uprawnień operacji partii poświadczenia OAuth.
-
Odpowiedzi o przekroczeniu limitu: Przekroczenie limitów konta może wywołać błąd
400 BATCH_LIMIT_EXCEEDED, lub wymagać ręcznej weryfikacji, jeśliPENDING_FOR_APPROVALjest skonfigurowany.
5. Równoległość, błędy API i ponowne próby
Integracje powinny utrzymywać konserwatywny profil równoległości. Ogranicz aktywne równoległe żądania do 5–10 równoczesnych połączeń. Używaj kolejek i przetwarzania wsadowego do przesyłania danych, zamiast wykonywać tysiące równoległych punktów końcowych.
Typowe odpowiedzi API & działania
| Status HTTP API | Znaczenie & Zalecana akcja |
|---|---|
| HTTP 401 Unauthorized | Błąd uwierzytelnienia (np. token wygasł lub został cofnięty). Sprawdź dane uwierzytelniające i zażądaj nowego tokena. |
| HTTP 429 Too Many Requests | Ograniczenie wskaźnika platformy. Wdróż logikę ponownego żądania używając wykładniczego opóźnienia z losowym jitterem. |
| 400 BATCH_LIMIT_EXCEEDED | Rozmiar ładunku przekracza dozwolone limity wykonywania wsadowego. Sprawdź ustawienia konta i podziel transakcję. |
⚙️ Strategia opóźnienia logiki ponownego żądania
Podczas obsługi odpowiadających HTTP 429, skonfiguruj harmonogram ponownych prób progresywnie (np. 1s, 2s, 4s, 8s, 16s, 32s, maksymalnie 60s) i zastosuj losowe opóźnienie (jitter), aby zapobiec lokalnym powodziom serwisowym. Uwaga: Powrót platformy z nagłówkiem 'Retry-After' jest niepotwierdzony.
6. Rozwiązywanie nieoczekiwanych błędów API
Jeśli Twoja integracja doświadcza uporczywych zakłóceń, przeprowadź szybki przegląd poniższego zestawu kontrolnego:
-
Zweryfikuj bazowy adres URL: Upewnij się, że wywołujesz bramę EloView 4 (
https://secure-api.eloview.com) a nie starszy host EloView 3. -
Zweryfikuj kody statusu: Oddziel problemy z autoryzacją (
HTTP 401) od ograniczania infrastruktury (HTTP 429). - Przeglądaj metryki operacyjne: Sprawdź czas życia ponownego wykorzystania tokenów, częstotliwości pollingu poszczególnych kiosków, wykorzystanie punktów końcowych masowych oraz aktywne liczby wątków równoległych.
📞 Eskalacja do wsparcia technicznego
Jeśli nieoczekiwane problemy z API trwają, skontaktuj się z Wsparciem Technicznym Elo. Aby przyspieszyć badania, proszę podać:
- Bazowy adres URL API i specyficzny punkt końcowy wywoływany
- Twoje publiczne źródłowe adresy IP
- Dokładne znaczniki czasowe zdarzeń (w tym strefa czasowa)
- Zwrócone kody statusu HTTP i pełne ładunki odpowiedzi
Please report any broken links by emailing elo.support@zebra.com and include a link to the knowledge article