Acquisisci screenshot del sito web con la nostra API RESTful Screenshot
L'API REST di GrabzIt ti permette di catturare URL o HTML interamente usando tecniche RESTful. Prima di iniziare, leggi attentamente le seguenti avvertenze, a seconda del tuo caso d'uso, una delle nostre altre soluzioni API potrebbe essere più adatta.
- Alcune funzionalità come l'unione e la crittografia delle acquisizioni non sono disponibili tramite questa API REST. Per utilizzare queste funzionalità dovrai utilizzarne un'altra Libreria API
- Non utilizzare questa API sul lato client, esporrà la chiave dell'applicazione! Invece usa il API JavaScript
- Per limitare quali server possono accedere alla tua API, autorizzare gli indirizzi IP a cui vuoi concedere l'accesso
Per iniziare, seleziona cosa vuoi fare dal filtro in basso e i parametri disponibili verranno visualizzati insieme a un esempio di base.
Quando si effettua una richiesta, assicurarsi contro tutti i i valori dei parametri sono codificati nell'URL.
Quando si converte HTML, tutti i parametri devono essere pubblicato nel corpo della richiesta come coppie chiave-valore. Assicurati che tutti i valori dei parametri siano codificati nell'URL e che il tipo di contenuto lo sia application / x-www-form-urlencoded.
L'acquisizione verrà quindi restituita nella risposta HTTP. Con questo tipo di acquisizione sono disponibili anche le seguenti opzioni aggiuntive, tutte facoltative ad eccezione di quelle contrassegnate come richieste. Durante il test della funzionalità API si consiglia di utilizzare Postino per semplificare il processo.
URL - l'URL dell'acquisizione.
Obbligatorio
html - l'HTML da convertire.
Obbligatorio
Quando si converte HTML è necessario utilizzare un HTTP POST.
personalizzato - l'identificatore personalizzato che puoi associare all'acquisizione.
Questo verrà restituito con qualsiasi URL di callback che hai specificato.
formato - il formato in cui dovrebbe essere l'acquisizione.
Predefinito: jpg
Opzioni:
bmp8
bmp16
bmp24
bmp
csv
gif
html
jpg
json
pdf
docx
png
SEO
tiff
mp4
WebP
xlsx
address - l'URL in cui eseguire il codice HTML. Può essere utile se l'HTML da convertire utilizza URL relativi a risorse come CSS e immagini.
Predefinito: vuoto
background - se vero, lo sfondo della pagina Web deve essere incluso nel PDF
Predefinito: 1
Opzioni:
0 = indica che il documento PDF non deve includere lo sfondo della pagina Web
1 = indica che il documento PDF deve includere lo sfondo della pagina Web
background - se vero, le immagini di sfondo della pagina Web devono essere incluse nel DOCX
Predefinito: 1
Opzioni:
0 = indica che il documento DOCX non deve includere le immagini di sfondo della pagina Web
1 = indica che il documento DOCX dovrebbe includere le immagini di sfondo della pagina web
bwidth - la larghezza del browser in pixel
Avviso questa funzione è attualmente in versione beta e potrebbe non fornire risultati coerenti.
Predefinito: 1366
Massimo: 10000
Larghezza automatica: -1 (passando -1 significa che il larghezza del browser corrisponde alla larghezza del documento)
bheight - l'altezza del browser in pixel.
Predefinito: 1170
Massimo: 10000
Lunghezza totale: -1 (passando -1 significa che viene presa una sequenza dell'intera pagina Web)
click - questo specifica l'elemento HTML, utilizzando un file Selettore CSS cliccare. Ricorda che potrebbe anche essere necessario un ritardo per visualizzare gli effetti del clic
Avviso questa funzione è attualmente in versione beta e potrebbe non fornire risultati coerenti.
country - Paese lo screenshot / acquisizione dovrebbe essere preso da.
Predefinito: la posizione più veloce corrente
Opzioni: "SG", "UK", "US"
coverurl - l'URL di una pagina Web che dovrebbe essere utilizzata come copertina per il PDF
height - l'altezza della miniatura risultante in pixel
Predefinito: se sia la larghezza dell'output che l'altezza dell'output non sono specificati o 0, la larghezza e l'altezza dell'output corrisponderanno alla larghezza e all'altezza dell'immagine finale, se la larghezza dell'output è specificata l'altezza dell'output sarà proporzionale alla larghezza dell'output
Massimo: altezza massima per pacchetto
Altezza totale: -1 (passando -1 significa che l'altezza della miniatura non viene ridotta)
altezza - l'altezza della GIF animata risultante in pixel.
Predefinito: 120px
Massimo: altezza massima per pacchetto
Dimensione automatica: -1 (passando -1 significa che l'altezza di la GIF animata viene ridimensionata in relazione alla sua larghezza, se l'altezza viene ridimensionata automaticamente la larghezza non può)
hide - il Selettori CSS di uno o più elementi HTML nella pagina Web da nascondere, per specificare più elementi HTML da nascondere separatamente ogni selettore con una virgola.
Predefinito: vuoto
includealltables - se vero, tutta la tabella della pagina Web verrà estratta con ciascuna tabella visualizzata in un foglio di calcolo separato.
Disponibile solo con il formato XLSX
Predefinito: 0
Opzioni:
0 = indica che tutte le tabelle non verranno estratte
1 = indica che verranno estratte tutte le tabelle
includeheadernames - se nella tabella saranno inclusi i nomi di intestazioni vere
Predefinito: 1
Opzioni:
0 = indica che i nomi delle intestazioni non verranno inclusi nella tabella
1 = indica che i nomi delle intestazioni verranno inclusi nella tabella
includeimages - se vero, le immagini della pagina Web devono essere incluse nel DOCX
Predefinito: 1
Opzioni:
0 = indica che il documento DOCX non includerà le immagini delle pagine Web
1 = indica che il documento DOCX includerà immagini di pagine Web
includelinks - true se i collegamenti devono essere inclusi nel documento
Predefinito: 1
Opzioni:
0 = indica che il documento non deve includere collegamenti
1 = indica che il documento deve includere i collegamenti
includeoutline - vero se Segnalibri PDF dovrebbe essere incluso
Predefinito: 0
Opzioni:
0 = indica che il documento PDF non includerà uno schema
1 = indica che il documento PDF includerà una struttura
proxy - i dettagli del proxy HTTP il software del browser dovrebbe utilizzare per creare questa acquisizione
post - eventuali parametri di post che si desidera inviare.
quality - il qualità della cattura, JPG e WEBP hanno una compressione predefinita del 90% e GIF dell'85%. Questo parametro non ha effetto sulle immagini BMP, PNG o TIFF.
Ridurre la qualità ridurrà le dimensioni del file e i tempi di download.
Predefinito: -1
Minimo: -1
Massimo: 100
ripetere - numero di volte per eseguire il ciclo della GIF animata.
Predefinito: 0
Ciclo continuo: 0
Non ripetere mai: -1
invertire - se vero, i frame della GIF animata sono invertiti
Predefinito: 0
Opzioni:
0 = indica che l'animazione non verrà riverita
1 = indica che l'animazione verrà invertita
requestas - il tipo di agente utente che si desidera utilizzare
Predefinito: 0
Opzioni:
0 = indica che è necessario restituire la versione standard del sito Web
1 = indica il versione mobile di un sito Web deve essere restituito
2 = indica che la visualizzazione del motore di ricerca di un sito Web deve essere restituita
velocità - la velocità della GIF animata.
Predefinito: 1
Minimo: 0.2
Massimo: 10
inizia a - la posizione iniziale del video che dovrebbe essere convertito into GIF animata.
Predefinito: 0 secondi
inizia a - l'ora di inizio in secondi dopo il caricamento da cui deve essere catturato il video.
Predefinito: 0 secondi
tabletoinclude - l'indice della tabella da convertire, dove tutte le tabelle di una pagina Web sono ordinate dalla parte superiore della pagina Web verso il basso
Predefinito: 1
target - questo parametro specifica il Selettore CSS dell'unico elemento HTML sulla pagina Web di destinazione che deve essere trasformato into un documento, tutte le altre parti della pagina Web vengono ignorate. Se sono presenti più elementi HTML corrispondenti, viene scelto il primo.
Predefinito: vuoto
target - questo parametro specifica il Selettore CSS dell'unico elemento HTML sulla pagina Web di destinazione che deve essere trasformato into immagine, tutte le altre parti della pagina Web vengono ignorate. Se sono presenti più elementi HTML corrispondenti, viene scelto il primo.
Predefinito: vuoto
target - l'id dell'unico elemento HTML nella pagina Web da cui utilizzare per estrarre le tabelle
templateid - aggiungere un modello ID che specifica l'intestazione e il piè di pagina del documento
Predefinito: vuoto
title - fornire un titolo al documento PDF
Predefinito: vuoto
waitfor - questo specifica l'elemento HTML, utilizzando un file Selettore CSS. Una volta che l'elemento è visibile viene eseguita la cattura. Se sono presenti più elementi HTML corrispondenti, viene scelto il primo. Quando viene utilizzato questo parametro, attenderà un massimo di 25 secondi prima che venga eseguita la cattura.
width - la larghezza della miniatura risultante in pixel
Predefinito: se sia la larghezza dell'output che l'altezza dell'output non sono specificati o 0, la larghezza e l'altezza dell'output corrisponderanno alla larghezza e all'altezza dell'immagine finale, se l'altezza dell'output è specificata, la larghezza dell'output sarà proporzionale all'altezza dell'output
Massima: larghezza massima per pacchetto
Larghezza intera: -1 (passando -1 significa che la larghezza della miniatura non viene ridotta)
larghezza - la larghezza della GIF animata risultante in pixel.
Predefinito: 180px
Massima: larghezza massima per pacchetto
Dimensione automatica: -1 (passando -1 significa che la larghezza di la GIF animata viene ridimensionata in relazione alla sua altezza, se la larghezza viene ridimensionata automaticamente, l'altezza non può)
Dettagli utente
Ottieni il tuo pacchetto di conto corrente e l'importo residuo con questa semplice chiamata.
Se c'è qualche problema con la richiesta che hai fatto all'API, verrà restituito un oggetto JSON che spiega l'errore. Il modo migliore per determinarlo è controllare il tipo di contenuto della risposta prima dell'elaborazione, se esiste application/json c'è stato un errore. Il codice di errore trovato nel JSON segue il file elenco standard di codici.
{
"Result": false,
"Code":"URL is missing",
"Message":100
}