Praktyczne poradniki Qivo
Jak działa API generowania kodu QR
API umożliwia automatyczne generowanie kodów QR z witryny internetowej, narzędzia wewnętrznego lub skryptów.
Twoja aplikacja wysyła treść i ustawienia; Qivo zwraca statyczny obraz QR. Tajny klucz pozostaje na serwerze.
Od edytora manualnego do integracji
W edytorze osoba wypełnia pola i kliknie pobieranie. przy użyciu API program wykonuje te działania, na przykład generując kod QR strony produktu podczas przygotowania etykiety.
Wzywanie API nie sprawia, że kod jest dynamiczny. obraz przechowuje podane dane zamiast pośredniego adresu URL Qivo. można zapisać i używać pliku bez ponownego kontaktu z generatorem.
Co zawiera żądanie
Wniosek GET zawiera adres serwisowy, parametry i tajny klucz. zawartośćParametr typu wybiera typ danych, format wybiera PNG lub SVG, a kształt, granica i centrum kontroluje projekt.
Wartości parametrów muszą być kodowane przez adres URL. Użyj standardowych narzędzi języka, aby prawidłowo zarządzać przestrzeń, + w liczbach telefonów i # w kolorach. Nieprawidłowe lub brakujące wymagane pola powodują odpowiedź na błąd.
Dlaczego klucz należy do serwera
Zwiedzający mogą przeczytać klucz umieszczony w publicznej stronie JavaScript. Wyślij zapytania z serwera i pobierz klucz z zmiennej środowiska.
Wyślij klucz w nagłówku X-API-Klucz za pośrednictwem HTTPS. parametr URL kluczowy jest również obsługiwany, ale URL mogą pojawić się w historii i dziennikach. Nigdy nie umieścić klucza tajnego w obrazie QR lub w przykładach publicznych.
Jak poradzić sobie z odpowiedzią
Skuteczna odpowiedź zawiera obraz sam, a nie JSON z linkem do pobrania. sprawdź status HTTP przed oszczędzaniem. błędy zwracają JSON z wyjaśnieniem; nie oszczędzaj tego jako PNG.
SVG jest przydatny dla materiałów drukowanych, podczas gdy PNG pasuje do codziennych obrazów. unikać odzyskiwania kodu na każdej wizycie na niezmienioną stronę: przechowywać i ponownie używać pliku. przestrzegać ograniczeń żądania i opóźnienia powrotu.
Co sprawdzić przed publikacją
API potwierdza wejście, ale nie dekoduje zakończonego obrazu. to zmniejsza przetwarzanie, ale przepływ pracy musi zajmować się testami skanowania. test typowych kombinacji projektowania i największych objęć danych oczekujesz.
Pozostaw lekką cichą strefę co najmniej czterech modułów, dobry kontrast i wystarczający rozmiar. Skanowanie ostatniego układu drukowanego za pomocą telefonu. Strona API zawiera parametry techniczne i gotowe do użycia przykłady PHP, JavaScript, Python i cURL.
Źródła i dalsza lektura
Opracowanie i wsparcie: Umind. Sprawdź wskazówki na docelowym projekcie i urządzeniach.