API-dokumentation
Har du en fråga? Kontakta oss.
Alla API-förfrågningar måste göras över HTTPS och använda HTTP Basic Auth med följande autentiseringsuppgifter:
Username: API KEY
Password: Not needed
Exempel
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d page_url=https://en.wikipedia.org/wiki/Eclipse
Flagga | Beskrivning |
|---|---|
-u | Passera grundläggande autentiseringsuppgifter, ett kolon efter API-nyckeln förhindrar cURL från att begära ett lösenord. |
-d | skicka data i POST-begäran |
Vid framgång, kommer du att få ett HTTP-svar med Status 302 (Omdirigering) och JSON-informationen kommer att finnas i svarets kropp.
# 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-version
Nuvarande version av API är 1.0.
Större API-version måste anges i URL som 'v' och nummer, t.ex. v1, v2, v3.
Exempel
https://api.printfriendly.com/v2/pdf/create
https://api.printfriendly.com/v2/html/create
API-metoder
Metod | Inmatning | Utdata |
|---|---|---|
PDF / skapa | URL / HTML | HTML |
html / skapa | URL / HTML |
Parametrar
Du måste ange parameter page_url eller html. Alla andra parametrar är valfria.
Parametrar | Värde |
|---|---|
Sid-URL | Målsidans URL |
HTML | HTML-innehåll för mål sidan |
css_url | URL för anpassad CSS-fil |
header_image_url | URL för anpassad headerbild |
Rubriktext | Textsträng |
Alla exempel nedan tillhandahålls för metoden "pdf/create" och fungerar också för metoden "html/create".
Exempel med 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'
Vid framgång, kommer du att få ett HTTP-svar med Status 302 (Omdirigering) och JSON-informationen kommer att finnas i svarets kropp.
Exempel med html-parameterar
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>'
Vid framgång får du ett HTTP-svar med status 200 och PDF/HTML-innehåll i svarsorganet.
Fel
PrintFriendly använder konventionella statuskoder och JSON-svar för att tillhandahålla feldetaljer.
Statuskoder
Status | Beskrivning |
|---|---|
200 OK | Allt fungerar bra. |
400 Felaktig begäran | Ett fel har inträffat. Se detaljer i JSON. |
401 Ej auktoriserad | 401 Ej auktoriserad |
404 Hittades inte | 404 Hittades inte |
429 För många förfrågningar | 429 För många förfrågningar |
Alla inte lyckade (inte Status 302 OK) svar har JSON-kropp med felinformation, inklusive feltyp och meddelande.
Felkategorier
Typ | Beskrivning |
|---|---|
Parametervalidering | Parameterverifiering misslyckades. |
Förbjudet domän | Den här domänen är tillfälligt avstängd. |
Misslyckades att parsa | Kan inte analysera sidan. Vi kan inte avgöra innehållet på den här sidan. |
Hämtningsfel | Kan inte hämta sidan. Kontrollera att URL är tillgänglig och försök igen. |
hög belastning | Parameterverifiering misslyckades. |
Ogiltig filändelse | Endast webbsidor stöds. Det är en PDF/TXT-fil eller bild (JPG, PNG, GIF). |
stor sida | Målsidan är över 2 MB. Stora sidor stöds inte. |
säkerhetsplattform | Säkerhetsplattformen hindrar oss från att hämta den här sidan. |
timeout | Timeout överskriden. Motorn kan inte behandla sidan under 30 sekunder. Försök igen senare. |
omfattande | Oväntat fel. Försök igen senare. |
Exempel
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d page_url=https://test.test
HTML-ingång
# 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"}
Begränsning av begärarfrekvens
API:n har en gräns på 60 förfrågningar per minut. Om du överskrider denna gräns får du ett svar med Status: 429 För många förfrågningar.
Rubrik | Beskrivning |
|---|---|
X-Hastighetsgräns | Totalt begäransgräns för aktuell period. |
X-Kvarvarande gräns | Återstående begäran för aktuell period. |
Återställ X-RateLimit | Antal sekunder till slutet av den aktuella perioden. |
Exempel med page_url-parameter
# 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