Maak website-screenshots met onze RESTful Screenshot API
Met de REST API van GrabzIt kunt u URL's of HTML volledig vastleggen met RESTful-technieken. Lees, voordat u begint, de volgende voorbehouden zorgvuldig door, afhankelijk van uw gebruiksscenario, een van onze andere API-oplossingen is wellicht geschikter.
- Sommige functies, zoals het samenvoegen en versleutelen van vastleggingen, zijn niet beschikbaar via deze REST API. Om deze functies te gebruiken, moet u een andere gebruiken API-bibliotheek
- Gebruik deze API niet aan de kant van de klant, het zal uw toepassingssleutel onthullen! Gebruik in plaats daarvan de JavaScript API
- Om te beperken welke servers toegang hebben tot uw API, autoriseer de IP-adressen waartoe u toegang wilt verlenen
Om te beginnen, selecteert u gewoon wat u wilt doen in het onderstaande filter en de beschikbare parameters worden samen met een eenvoudig voorbeeld weergegeven.
Zorg ervoor bij het maken van verzoeken allen parameterwaarden zijn URL-gecodeerd.
Bij het converteren van HTML moeten alle parameters zijn geplaatst in de aanvraagtekst als sleutel-waardeparen. Zorg ervoor dat alle parameterwaarden URL-gecodeerd zijn en dat het inhoudstype is application / x-www-form-urlencoded.
De opname wordt vervolgens geretourneerd in het HTTP-antwoord. De volgende extra opties zijn ook beschikbaar bij dit type opname, die allemaal optioneel zijn, behalve de opties die als vereist zijn gemarkeerd. Bij het testen van de API-functionaliteit raden we aan om: Postbode om het proces te vereenvoudigen.
url - de URL naar de opname.
Nodig
html - de HTML naar de conversie.
Nodig
Bij het converteren van HTML moet je een HTTP POST gebruiken.
aangepast - de aangepaste ID die u aan de opname kunt koppelen.
Dit wordt geretourneerd met elke callback-URL die u hebt opgegeven.
formaat - het formaat waarin de opname moet zijn.
Standaard: jpg
Opties:
bmp8
bmp16
bmp24
bmp
csv
gif
html
jpg
json
pdf
docx
png
seo
tiff
mp4
webp
xlsx
address - de URL om de HTML-code in uit te voeren. Kan handig zijn als de HTML die wordt geconverteerd relatieve URL's gebruikt naar bronnen zoals CSS en afbeeldingen.
Standaard: leeg
background - indien waar, moet de achtergrond van de webpagina in de PDF worden opgenomen
Standaard: 1
Opties:
0 = geeft aan dat het PDF-document de webpagina-achtergrond niet mag bevatten
1 = geeft aan dat het PDF-document de webpagina-achtergrond moet bevatten
background - indien waar, moeten de achtergrondafbeeldingen van de webpagina worden opgenomen in de DOCX
Standaard: 1
Opties:
0 = geeft aan dat het DOCX-document geen achtergrondafbeeldingen van de webpagina mag bevatten
1 = geeft aan dat het DOCX-document de achtergrondafbeeldingen van de webpagina moet bevatten
bwidth - de breedte van de browser in pixels
Waarschuwing deze functie is momenteel in bèta en biedt mogelijk geen consistente resultaten.
Standaard: 1366
Maximaal: 10000
Automatische breedte: -1 (doorgeven van -1 betekent dat de breedte van de browser komt overeen met de breedte van het document)
bheight - de hoogte van de browser in pixels.
Standaard: 1170
Maximaal: 10000
Volledige lengte: -1 (doorgeven van -1 betekent dat een sceenshot van de hele webpagina wordt gemaakt)
click - dit specificeert het HTML-element met behulp van een CSS-selector klikken. Onthoud dat een vertraging ook nodig kan zijn om de effecten van de klik te zien
Waarschuwing deze functie is momenteel in bèta en biedt mogelijk geen consistente resultaten.
country - het land de screenshot / opname moet worden genomen.
Standaard: de huidige snelste locatie
Opties: "SG", "UK", "US"
coverurl - de URL van een webpagina die als voorblad voor de PDF moet worden gebruikt
height - de hoogte van de resulterende miniatuur in pixels
Standaard: als zowel de uitvoerbreedte als de uitvoerhoogte niet zijn opgegeven of 0, dan komen de uitvoerbreedte en -hoogte overeen met de uiteindelijke breedte en hoogte van de afbeelding.Als de uitvoerbreedte is opgegeven, is de uitvoerhoogte evenredig met de uitvoerbreedte
Maximum: maximale hoogte voor pakket
Volledige hoogte: -1 (doorgeven van -1 betekent dat de hoogte van de miniatuur niet wordt verkleind)
Hoogte - de hoogte van de resulterende geanimeerde GIF in pixels.
Standaard: 120px
Maximum: maximale hoogte voor pakket
Auto-formaat: -1 (passeren van -1 betekent dat de hoogte van de geanimeerde GIF is geschaald in verhouding tot de breedte, als de hoogte automatisch wordt aangepast, kan de breedte niet)
hide - de CSS-selectors van de een of meer HTML-elementen op de webpagina die u wilt verbergen, om meerdere HTML-elementen op te geven om elke selector met een komma te verbergen.
Standaard: leeg
includealltables - indien waar, worden alle tabellen op de webpagina geëxtraheerd en wordt elke tabel in een afzonderlijk werkblad weergegeven.
Alleen beschikbaar met het XLSX-formaat
Standaard: 0
Opties:
0 = geeft aan dat alle tabellen niet worden geëxtraheerd
1 = geeft aan dat alle tabellen worden geëxtraheerd
includeheadernames - of echte kopnamen in de tabel worden opgenomen
Standaard: 1
Opties:
0 = geeft aan dat de kopnamen niet in de tabel worden opgenomen
1 = geeft aan dat de kopnamen in de tabel worden opgenomen
includeimages - indien waar, moeten de afbeeldingen van de webpagina worden opgenomen in de DOCX
Standaard: 1
Opties:
0 = geeft aan dat het DOCX-document geen afbeeldingen van webpagina's zal bevatten
1 = geeft aan dat het DOCX-document afbeeldingen van webpagina's zal bevatten
includelinks - waar als links in het document moeten worden opgenomen
Standaard: 1
Opties:
0 = geeft aan dat het document geen links mag bevatten
1 = geeft aan dat het document links moet bevatten
includeoutline - waar als PDF-bladwijzers moet worden opgenomen
Standaard: 0
Opties:
0 = geeft aan dat het PDF-document geen overzicht bevat
1 = geeft aan dat het PDF-document een overzicht zal bevatten
proxy - de HTTP-proxygegevens de browsersoftware moet gebruiken om deze opname te maken
post - alle postparameters die u wilt verzenden.
quality - de kwaliteit van de opname, JPG en WEBP hebben een standaardcompressie van 90% en GIF 85%. Deze parameter heeft geen effect op BMP-, PNG- of TIFF-afbeeldingen.
Het verminderen van de kwaliteit zal de bestandsgrootte verminderen en downloadtijden verkorten.
Standaard: -1
Minimum: -1
Maximaal: 100
herhaling - aantal keren dat de geanimeerde GIF in een lus moet worden geplaatst.
Standaard: 0
Lus continu: 0
Loop nooit: -1
omkeren - indien waar, worden de frames van de geanimeerde GIF omgekeerd
Standaard: 0
Opties:
0 = geeft aan dat de animatie niet zal worden teruggezet
1 = geeft aan dat de animatie wordt omgekeerd
requestas - het type user-agent dat u wilt gebruiken
Standaard: 0
Opties:
0 = geeft aan dat de standaardversie van de website moet worden geretourneerd
1 = geeft de mobiele versie van een website moet worden geretourneerd
2 = geeft aan dat de zoekmachineweergave van een website moet worden geretourneerd
snelheid - de snelheid van de geanimeerde GIF.
Standaard: 1
Minimum: 0.2
Maximaal: 10
begin - de startpositie van de video die moet worden geconverteerd intoa geanimeerde GIF.
Standaard: 0 seconden
begin - de starttijd in seconden na het laden waarvan de video moet worden vastgelegd.
Standaard: 0 seconden
tabletoinclude - de index van de te converteren tabel, waarbij alle tabellen op een webpagina van boven naar beneden zijn geordend
Standaard: 1
target - deze parameter specificeert de CSS-selector van het enige HTML-element op de doelwebpagina dat moet worden omgedraaid intoa document, worden alle andere delen van de webpagina genegeerd. Als er meerdere overeenkomende HTML-elementen zijn, wordt de eerste gekozen.
Standaard: leeg
target - deze parameter specificeert de CSS-selector van het enige HTML-element op de doelwebpagina dat moet worden omgedraaid intoa afbeelding, worden alle andere delen van de webpagina genegeerd. Als er meerdere overeenkomende HTML-elementen zijn, wordt de eerste gekozen.
Standaard: leeg
target - de id van het enige HTML-element op de webpagina dat moet worden gebruikt om tabellen uit te halen
templateid - Voeg een ... toe sjabloon ID die de kop- en voettekst van het document aangeeft
Standaard: leeg
title - geef een titel op voor het PDF-document
Standaard: leeg
waitfor - dit specificeert het HTML-element met behulp van een CSS-selector. Zodra het element is zichtbaar wordt de opname uitgevoerd. Als er meerdere overeenkomende HTML-elementen zijn, wordt de eerste gekozen. Wanneer deze parameter wordt gebruikt, wacht deze maximaal 25 seconden voordat de opname wordt uitgevoerd.
width - de breedte van de resulterende miniatuur in pixels
Standaard: als zowel de uitvoerbreedte als de uitvoerhoogte niet zijn opgegeven of 0, dan komen de uitvoerbreedte en -hoogte overeen met de uiteindelijke breedte en hoogte van de afbeelding.Als de uitvoerhoogte is opgegeven, is de uitvoerbreedte evenredig met de uitvoerhoogte
Maximum: maximale breedte voor pakket
Volledige breedte: -1 (passeren van -1 betekent dat de breedte van de miniatuur niet wordt verkleind)
Breedte - de breedte van de resulterende geanimeerde GIF in pixels.
Standaard: 180px
Maximum: maximale breedte voor pakket
Auto-formaat: -1 (passerend -1 betekent dat de breedte van de geanimeerde GIF is geschaald in verhouding tot de hoogte, als de breedte automatisch wordt aangepast, kan de hoogte niet)
gebruiker Details
Ontvang uw betaalrekeningpakket en het resterende saldo met dit eenvoudige telefoontje.
Als er een probleem is met het verzoek dat u aan de API hebt gedaan, wordt een JSON-object geretourneerd met een uitleg van de fout. De beste manier om dit te bepalen, is door het inhoudstype van het antwoord te controleren voordat het wordt verwerkt application/json er is een fout opgetreden. De foutcode gevonden in de JSON volgt de standaard lijst met codes.
{
"Result": false,
"Code":"URL is missing",
"Message":100
}