Rób zrzuty ekranu witryny za pomocą naszego interfejsu API RESTful Screenshot

Interfejs API REST firmy GrabzIt pozwala na przechwytywanie adresów URL lub HTML całkowicie przy użyciu technik RESTful. Zanim zaczniesz, przeczytaj uważnie poniższe ostrzeżenia, w zależności od przypadku użycia jedno z naszych innych rozwiązań API może być bardziej odpowiednie.

- Niektóre funkcje, takie jak scalanie i szyfrowanie przechwytywania, nie są dostępne za pośrednictwem tego interfejsu API REST. Aby korzystać z tych funkcji, musisz użyć innego Biblioteka API
- Nie używaj tego API po stronie klienta, ujawni to twój klucz aplikacji! Zamiast tego użyj JavaScript API

Aby rozpocząć, po prostu wybierz, co chcesz zrobić z poniższego filtra, a dostępne parametry zostaną wyświetlone wraz z podstawowym przykładem.

Co chcesz robić?

Przy składaniu wniosków proszę się upewnić cała kolekcja wartości parametrów są zakodowane w postaci adresu URL.

    https://api.grabz.it/services/convert?key=Sign in to view your Application Key&format=&url=https%3A%2F%2Fspacex.com%2F

Podczas konwersji HTML wszystkie parametry muszą być opublikowane w treści wniosku jako pary klucz-wartość. Upewnij się, że wszystkie wartości parametrów są zakodowane w adresie URL, a typ zawartości jest zakodowany Aplikacja / x-www-form-urlencoded.

    curl 
    -d key=Sign in to view your Application Key 
    -d format= 
    -d html=%3Ch1%3EConvert%20Me%21%3C%2Fh1%3E 
    https://api.grabz.it/services/convert

Przechwycenie zostanie następnie zwrócone w odpowiedzi HTTP. Następujące dodatkowe opcje są również dostępne w przypadku tego typu przechwytywania, z których wszystkie są opcjonalne, z wyjątkiem tych oznaczonych jako wymagane. Podczas testowania funkcjonalności API zalecamy użycie Listonosz uprościć proces.

url - adres URL do przechwycenia.
- Wymagane
html - HTML do konwersji.
- Wymagane
- Podczas konwersji HTML musisz użyć HTTP POST.
klucz - Twój Klucz aplikacji.
- Wymagane
oddzwonić - adres URL programu obsługi, który GrabzIt powinien wywołać po zakończeniu pracy.
- Dowiedz się, jak utworzyć procedurę obsługi, postępując zgodnie z dokumentacją dla każdego języka ASP.NET, Java, node.js, Perl, PHP, Python i Rubin.
dostosować - niestandardowy identyfikator, który można powiązać z przechwytywaniem.
- Zostanie on zwrócony z dowolnym określonym adresem URL wywołania zwrotnego.
format - format, w jakim powinno być przechwytywanie.
- Domyślnie: jpg
- Opcje:
  - bmp8
  - bmp16
  - bmp24
  - bmp
  - CSV
  - gif
  - html
  - jpg
  - json
  - pdf
  - docx
  - png
  - seo
  - sprzeczka
  - webp
  - xlsx
address - adres URL do wykonania kodu HTML. Może być przydatny, jeśli konwertowany HTML używa względnych adresów URL do zasobów takich jak CSS i obrazy.
- Domyślnie: pusty
background - jeśli to prawda, tło strony internetowej powinno być zawarte w pliku PDF
- Domyślnie: 1
- Opcje:
  - 0 = oznacza, że dokument PDF nie powinien zawierać tła strony internetowej
  - 1 = oznacza, że dokument PDF powinien zawierać tło strony internetowej
background - jeśli to prawda, obrazy tła strony internetowej powinny być zawarte w DOCX
- Domyślnie: 1
- Opcje:
  - 0 = oznacza, że dokument DOCX nie powinien zawierać obrazów tła strony internetowej
  - 1 = oznacza, że dokument DOCX powinien zawierać obrazy tła strony internetowej
bwidth - szerokość przeglądarki w pikselach
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
- Domyślnie: 1366
- Maksymalna ilość znaków: 10000
- Automatyczna szerokość: -1 (przekazanie -1 oznacza, że szerokość przeglądarki dopasowuje szerokość dokumentu)
bheight - wysokość przeglądarki w pikselach.
- Domyślnie: 1170
- Maksymalna ilość znaków: 10000
- Pełna długość: -1 (przekazanie -1 oznacza, że wykonano sceenshot całej strony)
click - określa element HTML, używając pliku Selektor CSS kliknąć. Pamiętaj, że opóźnienie może być również wymagane do wyświetlenia efektów kliknięcia
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
country - kraj zrzut ekranu / przechwytywanie należy pobrać.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: „SG”, „UK”, „US”
coverurl - adres URL strony internetowej, która powinna być używana jako strona tytułowa pliku PDF
- Domyślnie: pusty
customwatermarkid - dodać zwyczaj watermark do pliku
- Domyślnie: pusty
delay - liczba milisekund do poczekaj przed wykonaniem zrzutu ekranu
- Domyślnie: 0
- Maksymalna ilość znaków: 30000
czas trwania - długość w sekundach filmu, który należy przekonwertować into animowany GIF.
- Domyślnie: maksymalna długość paczki
export - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane.
fps - liczba klatek na sekundę, które powinny zostać przechwycone z wideo.
- Domyślnie: 10
- Minimum: 0.2
- Maksymalna ilość znaków: 60
hd - jeśli to prawda, obraz przechwytywanie będzie w wysokiej rozdzielczości podwaja to rozmiar wymiarów obrazu.
- Domyślnie: 0
- Opcje:
  - 0 = utwórz obraz o wysokiej rozdzielczości
  - 1 = utwórz obraz o wysokiej rozdzielczości
height - wysokość powstałej miniatury w pikselach
- Domyślnie: jeśli nie określono zarówno szerokości wyjściowej, jak i wysokości wyjściowej lub 0, wówczas szerokość i wysokość wyjściowa będą zgodne z ostateczną szerokością i wysokością obrazu, jeśli określono szerokość wyjściową, wysokość wyjściowa będzie proporcjonalna do szerokości wyjściowej
- Maksymalna: maksymalna wysokość paczki
- Pełna wysokość: -1 (przekazanie -1 oznacza, że wysokość miniatury nie jest zmniejszona)
height - w niestandardowa wysokość wynikowego dokumentu w mm
- Zaniedbanie: rozmiar strony wysokość
- Minimum: 15
wysokość - wysokość powstałego animowanego GIF-a w pikselach.
- Domyślnie: 120px
- Maksymalna: maksymalna wysokość paczki
- Rozmiar automatyczny: -1 (przekazanie -1 oznacza, że wysokość animowany GIF jest skalowany w stosunku do szerokości, jeśli wysokość jest automatycznie dopasowywana, szerokość nie może)
hide - w Selektory CSS jednego lub więcej elementów HTML na stronie internetowej do ukrycia, aby określić wiele elementów HTML do ukrycia, oddziel każdy selektor przecinkiem.
- Domyślnie: pusty
includealltables - jeśli to prawda, cała tabela na stronie internetowej zostanie wyodrębniona, a każda tabela pojawi się w osobnym arkuszu kalkulacyjnym.
- Dostępne tylko w formacie XLSX
- Domyślnie: 0
- Opcje:
  - 0 = wskazuje, że wszystkie tabele nie zostaną wyodrębnione
  - 1 = wskazuje, że wszystkie tabele zostaną wyodrębnione
includeheadernames - jeśli prawdziwe nazwy nagłówków zostaną uwzględnione w tabeli
- Domyślnie: 1
- Opcje:
  - 0 = wskazuje, że nazwy nagłówków nie będą uwzględnione w tabeli
  - 1 = wskazuje, że nazwy nagłówków zostaną uwzględnione w tabeli
includeimages - jeśli to prawda, obrazy strony internetowej powinny być zawarte w DOCX
- Domyślnie: 1
- Opcje:
  - 0 = oznacza, że dokument DOCX nie będzie zawierał obrazów stron internetowych
  - 1 = oznacza, że dokument DOCX będzie zawierał obrazy stron internetowych
includelinks - prawda, jeśli w dokumencie powinny być zawarte linki
- Domyślnie: 1
- Opcje:
  - 0 = oznacza, że dokument nie powinien zawierać linków
  - 1 = oznacza, że dokument powinien zawierać linki
includeoutline - prawda, jeśli Zakładki PDF powinno być dołączone
- Domyślnie: 0
- Opcje:
  - 0 = oznacza, że dokument PDF nie będzie zawierał konspektu
  - 1 = oznacza, że dokument PDF będzie zawierał kontur
mergeid - dodaj identyfikator przechwytywania, który powinien być scalone na początku nowego dokumentu
- Domyślnie: pusty
mtop - margines w milimetrach, który powinien pojawić się u góry strony dokumentu
- Domyślnie: 10
mleft - margines w milimetrach, który powinien pojawić się po lewej stronie strony dokumentu
- Domyślnie: 10
mbottom - margines w milimetrach, który powinien pojawić się na dole strony dokumentu
- Domyślnie: 10
mright - margines w milimetrach, który powinien pojawić się po prawej stronie dokumentu PDF
- Domyślnie: 10
media - w CSS Media Typ dokumentu PDF
- Domyślnie: Parint
- Opcje:
  - Ekran
noads - Jeśli prawda reklamy powinny być automatycznie ukryte.
- Domyślnie: 0
- Opcje:
  - 0 = wyświetlaj reklamy
  - 1 = ukryj reklamy
nonotify - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
- Domyślnie: 0
- Opcje:
  - 0 = wyświetl powiadomienia o plikach cookie
  - 1 = ukryj powiadomienia o plikach cookie
orientation - orientacja dokumentu
- Domyślnie: portret
- Opcje:
  - Portret
  - Krajobraz
pagesize - rozmiar strony dokumentu
- Domyślnie: A4
- Opcje:
  - A3
  - A4
  - A5
  - A6
  - B3
  - B4
  - B5
  - B6
  - Regulamin
  - List
password - w hasło do ochrony dokumentu z
- Domyślnie: pusty
proxy - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
post - dowolne parametry posta, które chcesz wysłać.
quality - w jakość przechwytywania, JPG i WEBP mają domyślną kompresję 90%, a GIF 85%. Ten parametr nie ma wpływu na obrazy BMP, PNG lub TIFF.
- Zmniejszenie jakości zmniejszy rozmiar plików i skróci czas pobierania.
- Domyślnie: -1
- Minimum: -1
- Maksymalna ilość znaków: 100
powtarzać - ile razy zapętlono animowany GIF.
- Domyślnie: 0
- Pętla w sposób ciągły: 0
- Nigdy nie pętla: -1
rewers - jeśli to prawda, ramki animowanego GIF-a są odwrócone
- Domyślnie: 0
- Opcje:
  - 0 = oznacza, że animacja nie zostanie cofnięta
  - 1 = oznacza, że animacja zostanie odwrócona
requestas - rodzaj agenta użytkownika, którego chcesz używać
- Domyślnie: 0
- Opcje:
  - 0 = oznacza, że standardowa wersja strony powinna zostać zwrócona
  - 1 = oznacza wersja mobilna strony internetowej powinien zostać zwrócony
  - 2 = wskazuje, że widok witryny w wyszukiwarce powinien zostać zwrócony
prędkość - prędkość animowanego GIF-a.
- Domyślnie: 1
- Minimum: 0.2
- Maksymalna ilość znaków: 10
początek - początkowa pozycja filmu, który należy przekonwertować into animowany GIF.
- Domyślnie: 0 sekund
tabletoinclude - indeks tabeli do przekonwertowania, w której wszystkie tabele na stronie internetowej są uporządkowane od góry strony do dołu
- Domyślnie: 1
target - ten parametr określa Selektor CSS jedynego elementu HTML na docelowej stronie internetowej, który ma zostać włączony into dokument, wszystkie inne części strony są ignorowane. Jeśli istnieje wiele pasujących elementów HTML, wybierany jest pierwszy.
- Domyślnie: pusty
target - ten parametr określa Selektor CSS jedynego elementu HTML na docelowej stronie internetowej, który ma zostać włączony into obraz, wszystkie inne części strony są ignorowane. Jeśli istnieje wiele pasujących elementów HTML, wybierany jest pierwszy.
- Domyślnie: pusty
target - identyfikator jedynego elementu HTML na stronie internetowej, którego należy użyć do wyodrębnienia tabel
- Domyślnie: pusty
transparent - jeśli to prawda przechwytywanie obrazu powinno być przezroczyste. Jest to zgodne tylko z obrazami png i tiff.
- Domyślnie: 0
- Opcje:
  - 0 = utwórz nieprzezroczysty obraz
  - 1 = utwórz przezroczysty obraz
templateid - dodać szablon Identyfikator określający nagłówek i stopkę dokumentu
- Domyślnie: pusty
title - podać tytuł dokumentu PDF
- Domyślnie: pusty
waitfor - określa element HTML, używając pliku Selektor CSS. Kiedy element jest widoczne przechwytywanie jest wykonywane. Jeśli istnieje wiele pasujących elementów HTML, wybierany jest pierwszy. Gdy użyty zostanie ten parametr, będzie on czekał maksymalnie 25 sekund przed wykonaniem przechwytywania.
width - szerokość wynikowej miniatury w pikselach
- Domyślnie: jeśli nie określono zarówno szerokości wyjściowej, jak i wysokości wyjściowej lub 0, wówczas szerokość i wysokość wyjściowa będą zgodne z ostateczną szerokością i wysokością obrazu, jeśli określono wysokość wyjściową, szerokość wyjściowa będzie proporcjonalna do wysokości wyjściowej
- Maksymalna: maksymalna szerokość paczki
- Pełna szerokość: -1 (przekazanie -1 oznacza, że szerokość miniatury nie jest zmniejszona)
width - w niestandardowa szerokość wynikowego dokumentu w mm
- Zaniedbanie: rozmiar strony szerokość
- Minimum: 15
szerokość - szerokość wynikowego animowanego GIF-a w pikselach.
- Domyślnie: 180px
- Maksymalna: maksymalna szerokość paczki
- Rozmiar automatyczny: -1 (przekazanie -1 oznacza, że szerokość animowany GIF jest skalowany w stosunku do jego wysokości, jeśli szerokość jest automatycznie dopasowywana, wysokość nie może)

Obsługa błędów

Jeśli wystąpi jakiś problem z żądaniem przesłanym do interfejsu API, zostanie zwrócony obiekt JSON z wyjaśnieniem błędu. Najlepszym sposobem ustalenia tego jest sprawdzenie typu treści odpowiedzi przed jej przetworzeniem, jeśli jest application/json Wystąpił błąd. Kod błędu znaleziony w JSON następuje po standardowa lista kodów.

{
    "Result": false,
    "Code":"URL is missing",
    "Message":100
}