Dokumentacja API
Masz pytanie? Skontaktuj się z nami.
Wszystkie żądania API muszą być wykonywane za pośrednictwem HTTPS i używać HTTP Basic Auth z następującymi danymi uwierzytelniającymi:
Username: API KEY
Password: Not needed
Przykład
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d page_url=https://en.wikipedia.org/wiki/Eclipse
Flaga | Opis |
|---|---|
-u | Przekaż podstawowe dane uwierzytelniające, podwójny dwukropek po kluczu API uniemożliwia cURL żądanie hasła. |
-d | prześlij dane w żądaniu POST |
W przypadku sukcesu otrzymasz odpowiedź HTTP ze statusem 302 (Przekierowanie), a informacje JSON będą w ciele odpowiedzi.
# 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"}
Wersja API
Aktualna wersja API to 1.0.
Główna wersja API musi być podana w URL jako 'v' i liczba, np. v1, v2, v3.
Przykład
https://api.printfriendly.com/v2/pdf/create
https://api.printfriendly.com/v2/html/create
Metody API
Metoda | Wejście | Wynik |
|---|---|---|
PDF / utwórz | URL / HTML | HTML |
html / utwórz | URL / HTML |
Parametry
Musisz podać parametr page_url lub html. Wszystkie inne parametry są opcjonalne.
Parametry | Wartość |
|---|---|
Adres URL strony | URL strony docelowej |
HTML | Zawartość HTML strony docelowej |
css_url | URL dla niestandardowego pliku CSS |
header_image_url | URL dla niestandardowego obrazu nagłówka |
Tekst nagłówka | Łańcuch tekstowy |
Wszystkie poniższe przykłady są podane dla metody "pdf/create" i działają również dla metody "html/create".
Przykład z parametrem 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'
W przypadku sukcesu otrzymasz odpowiedź HTTP ze statusem 302 (Przekierowanie), a informacje JSON będą w ciele odpowiedzi.
Przykład z parametrami 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>'
W przypadku sukcesu otrzymasz odpowiedź HTTP ze statusem 200 i zawartością PDF/HTML w treści odpowiedzi.
Błędy
PrintFriendly używa konwencjonalnych kodów statusów i odpowiedzi JSON do podawania szczegółów błędów.
Kody statusu
Status | Opis |
|---|---|
200 OK | Wszystko działa dobrze. |
400 Niepoprawne żądanie | Wystąpił błąd. Zobacz szczegóły w JSON. |
401 Niedozwolony | 401 Niedozwolony |
404 Nie znaleziono | 404 Nie znaleziono |
429 Za dużo żądań | 429 Za dużo żądań |
Wszystkie odpowiedzi nieudane (nie Status 302 OK) zawierają ciało JSON z szczegółami błędu, które będą zawierać typ błędu i wiadomość.
Rodzaje błędów
Typ | Opis |
|---|---|
Walidacja parametrów | Weryfikacja parametrów nie powiodła się. |
Zabroniona domena | Ta domena jest tymczasowo zablokowana. |
Niepowodzenie parsowania | Nie można przeanalizować strony. Nie możemy określić zawartości tej strony. |
Błąd pobierania | Nie można pobrać strony. Sprawdź, czy URL jest dostępny, i spróbuj ponownie. |
wysokie obciążenie | Walidacja parametrów zakończyła się niepowodzeniem. |
Nieprawidłowe rozszerzenie pliku | Obsługiwane są tylko strony internetowe. Jest to plik PDF/TXT lub obraz (JPG, PNG, GIF). |
duża strona | Docelowa strona ma ponad 2 MB. Duże strony nie są obsługiwane. |
platforma bezpieczeństwa | Platforma bezpieczeństwa blokuje pobranie tej strony. |
limit czasu | Limit czasu został przekroczony. Silnik nie może przetworzyć strony w ciągu 30 sekund. Spróbuj ponownie później. |
wszechstronny | Nieoczekiwany błąd. Proszę spróbować ponownie później. |
Przykład
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d page_url=https://test.test
Wprowadzanie HTML
# 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"}
Ograniczenie szybkości żądań
API ma limit 60 żądań na minutę. Jeśli przekroczysz ten limit, otrzymasz odpowiedź ze statusem: 429 Zbyt wiele żądań.
Nagłówek | Opis |
|---|---|
Ograniczenie-X-Stawka | Całkowity limit żądań na bieżący okres. |
X-Pozostały limit | Pozostałe żądania na bieżący okres. |
Zresetuj X-RateLimit | Ilość sekund do końca bieżącego okresu. |
Przykład z parametrem 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