API-documentatie
Heeft u een vraag? Neem contact met ons op.
Alle API-verzoeken moeten via HTTPS worden gedaan en HTTP Basic Auth gebruiken met de volgende referenties:
Username: API KEY
Password: Not needed
Voorbeeld
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d page_url=https://en.wikipedia.org/wiki/Eclipse
Vlag | Beschrijving |
|---|---|
-u | Geef de basisverificatiegegevens door, een dubbele punt na de API-sleutel voorkomt dat cURL om een wachtwoord vraagt. |
-d | gegevens verzenden in POST-verzoek |
In het geval van succes, krijg je een HTTP-reactie met Status 302 (Redirect) en vind je de JSON-informatie in de reactiebody.
# HTTP RESPONSE
# HEADERS (some of headers are ommited)
Content-Type: application/json; charset=utf-8
Status: 302 Found
Location: https://v.printfriendly.com/system/pdfs/pdf_1480936999_755625A4.pdf
# BODY
{"success":"Redirect to https://v.printfriendly.com/system/pdfs/pdf_1480947535_6e7ecaA4.pdf"}
API-versie
De huidige versie van de API is 1.0.
De hoofdversie van de API moet worden opgegeven in de URL als 'v' en een nummer, bijvoorbeeld v1, v2, v3.
Voorbeeld
https://api.printfriendly.com/v2/pdf/create
https://api.printfriendly.com/v2/html/create
API-methoden
Methode | Invoer | Uitvoer |
|---|---|---|
PDF / maken | URL / HTML | HTML |
html / maken | URL / HTML |
Parameters
U moet de parameter page_url of html opgeven. Alle andere parameters zijn optioneel.
Parameters | Waarde |
|---|---|
Pagina-URL | URL van de doelpagina |
HTML | HTML-inhoud van de doelpagina |
css_url | URL voor aangepaste CSS-bestand |
header_image_url | URL voor aangepaste kopafbeelding |
Headertekst | Tekststring |
Alle onderstaande voorbeelden worden verstrekt voor de methode "pdf/create" en werken ook voor de methode "html/create".
Voorbeeld met page_url-parameter
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d page_url=https://test.test /
-d css_url=https://my-site.com/pdf_style.css /
-d header_text='My Custom Header'
In het geval van succes, krijg je een HTTP-reactie met Status 302 (Redirect) en vind je de JSON-informatie in de reactiebody.
Voorbeeld met html-parameters
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d html='<html><body><h1>Title</h1><p>Text text text text text text text text text</p></body></html>'
In geval van succes ontvang je een HTTP-reactie met Status 200 en PDF/HTML-inhoud in de reactiebody.
Fouten
PrintFriendly gebruikt conventionele statuscodes en JSON-reacties om foutdetails te bieden.
Statuscodes
Status | Beschrijving |
|---|---|
200 OK | Alles werkt prima. |
400 Ongeldige aanvraag | Er is een fout opgetreden. Bekijk details in JSON. |
401 Niet toegestaan | 401 Niet toegestaan |
404 Niet gevonden | 404 Niet gevonden |
429 Te veel aanvragen | 429 Te veel aanvragen |
Alle niet succesvolle (niet Status 302 OK) antwoorden hebben een JSON-lichaam met de foutdetails, inclusief het type fout en bericht.
Fouttypen
Type | Beschrijving |
|---|---|
Parameter validatie | Validatie van parameters is mislukt. |
Verboden domein | Deze domein is tijdelijk verboden. |
Parsing mislukt | Kan pagina niet analyseren. We kunnen de inhoud van deze pagina niet bepalen. |
Ophaalfout | Pagina kan niet worden opgehaald. Controleer of de URL toegankelijk is en probeer het opnieuw. |
hoge belasting | Validatie van parameters is mislukt. |
Ongeldige bestandsextensie | Alleen webpagina's worden ondersteund. Het is een PDF/TXT-bestand of afbeelding (JPG, PNG, GIF). |
grote pagina | Doelpagina is groter dan 2 MB. Grote pagina's worden niet ondersteund. |
veiligheidsplatform | Het beveiligingsplatform blokkeert ons om deze pagina te ophalen. |
timeout | Time-out overschreden. De engine kan de pagina niet binnen 30 seconden verwerken. Probeer het later opnieuw. |
allesomvattend | Onverwachte fout. Probeer het later opnieuw. |
Voorbeeld
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d page_url=https://test.test
HTML-invoer
# HTTP RESPONSE
# HEADERS (some of headers were ommited)
Content-Type: application/json; charset=utf-8/
Status: 400 Bad Request
# BODY (JSON)
{"status":"failed","message":"Print technology unable to download or parse content"}
Verzoekssnelheid beperken
De API heeft een limiet van 60 aanvragen per minuut. Als u deze limiet overschrijdt, ontvangt u een antwoord met Status: 429 Te Veel Aanvragen.
Koptekst | Beschrijving |
|---|---|
X-Snelheidslimiet | Totale verzoeklimiet voor de huidige periode. |
X-Resterende limiet | Resterend verzoek voor de huidige periode. |
X-RateLimit opnieuw instellen | Aantal seconden tot het einde van de huidige periode. |
Voorbeeld met de parameter page_url
# HEADERS (some of headers were ommited)
Status: 429 Too Many Requests
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 20
# BODY (JSON)Empty