Documentació de l'API
Tens alguna pregunta? Contacta'ns.
Totes les sol·licituds API s'han de fer a través de HTTPS i utilitzar HTTP Basic Auth amb les credencials següents:
Username: API KEY
Password: Not needed
Exemple
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d page_url=https://en.wikipedia.org/wiki/Eclipse
Bandera | Descripció |
|---|---|
-u | Passa les credencials bàsiques d'autenticació, dos punts després de la clau de l'API impedeixen que cURL demani una contrasenya. |
-d | envia les dades en una sol·licitud POST |
En cas de èxit, rebràs una resposta http amb l'estat 302 (Redirecció) i la informació JSON estarà al cos de la resposta.
# 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"}
Versió de l'API
La versió actual de l'API és 1.0.
La versió principal de l'API s'ha de proporcionar a l'URL com 'v' i un número, per exemple v1, v2, v3.
Exemple
https://api.printfriendly.com/v2/pdf/create
https://api.printfriendly.com/v2/html/create
Mètodes API
Mètode | Entrada | Sortida |
|---|---|---|
PDF / crear | URL / HTML | HTML |
html / crear | URL / HTML |
Paràmetres
Has de proporcionar el paràmetre page_url o html. Tots els altres paràmetres són opcionals.
Paràmetres | Valor |
|---|---|
URL de la pàgina | URL de la pàgina objectiu |
HTML | Contingut HTML de la pàgina objectiu |
css_url | URL per al fitxer CSS personalitzat |
header_image_url | URL per a la imatge de la capçalera personalitzada |
Text de capçalera | Cadena de text |
Tots els exemples a continuació s'ofereixen per al mètode "pdf/create" i també funcionen per al mètode "html/create".
Exemple amb el paràmetre page_url
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'
En cas de èxit, rebràs una resposta http amb l'estat 302 (Redirecció) i la informació JSON estarà al cos de la resposta.
Exemple amb paràmetres html
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>'
En cas de èxit, rebràs una resposta http amb l'estat 200 i contingut PDF/HTML en el cos de la resposta.
Errors
PrintFriendly utilitza codis d'estat convencionals i respostes JSON per proporcionar detalls d'errors.
Codis d'estat
Estat | Descripció |
|---|---|
200 D'acord | Tot funciona bé. |
400 Sol·licitud incorrecta | S'ha produït un error. Vegeu els detalls a JSON. |
401 No autoritzat | 401 No autoritzat |
404 No trobat | 404 No trobat |
429 Massa sol·licituds | 429 Massa sol·licituds |
Totes les respostes no exitoses (no Status 302 OK) tenen un cos JSON amb els detalls de l'error, que inclourà el tipus d'error i el missatge.
Tipus d'errors
Tipus | Descripció |
|---|---|
Validació de paràmetres | La validació dels paràmetres ha fallat. |
Domini prohibit | Aquest domini està temporalment prohibit. |
Error de parsing | No es pot analitzar la pàgina. No podem determinar el contingut d'aquesta pàgina. |
Error de recuperació | No es pot carregar la pàgina. Comproveu que l'URL sigui accessible i torneu-ho a intentar. |
alta càrrega | La validació dels paràmetres ha fallat. |
Extensió de fitxer no vàlida | Només es donen suport a pàgines web. És un fitxer PDF/TXT o una imatge (JPG, PNG, GIF). |
pàgina gran | La pàgina de destinació supera 2 MB. Les pàgines grans no són compatibles. |
plataforma de seguretat | La plataforma de seguretat impedeix que accedim a aquesta pàgina. |
temps d'espera | S'ha superat el límit de temps. El motor no pot processar la pàgina en 30 segons. Si us plau, torna a intentar-ho més tard. |
general | Error inesperat. Si us plau, torneu-ho a intentar més tard. |
Exemple
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d page_url=https://test.test
HTML input
# 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"}
Limitació de la taxa de sol·licituds
L'API té un límit de 60 peticions per minut. Si supereu aquest límit, rebreu una resposta amb l'estat: 429 Massa sol·licituds.
Capçalera | Descripció |
|---|---|
Límit de taxa-X | Límit total de sol·licituds per al període actual. |
X-Límit de tarifa restant | Sol·licituds restants per al període actual. |
Restablir el límit de velocitat X | Quantitat de segons fins al final del període actual. |
Exemple amb el paràmetre 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