Dodaj konwersję plików do swojej aplikacji
Korzystaj z REST API FileConvertFree w aplikacjach, backendach, automatyzacjach i systemach firmowych do konwersji PDF oraz obrazów.
Szybki start
Plany i limity API
Limity są wspólne dla całego konta API i wszystkich kluczy. Utworzenie dodatkowych kluczy nie zwiększa dostępnej kwoty.
Premium
200 / day- 200 Żądania dziennie
- 30 Żądania na minutę
- 200 MB Maksymalny rozmiar pliku
- 3 Aktywne klucze max
Pro
400 / day- 400 Żądania dziennie
- 60 Żądania na minutę
- 200 MB Maksymalny rozmiar pliku
- 3 Aktywne klucze max
Zarządzanie kluczami API
1. Utwórz klucz
W Panelu, w sekcji API dla programistów, możesz utrzymywać do 3 aktywnych kluczy API. Nadawaj im czytelne nazwy, np. Produkcja, Aplikacja biurowa lub Testy.
2. Zapisz go od razu
Pełny sekret jest pokazywany tylko po utworzeniu lub regeneracji. FileConvertFree przechowuje bezpieczny skrót, a nie jawny sekret, dlatego pełnego klucza nie można później ponownie wyświetlić.
3. Regeneracja klucza
Regeneracja tworzy nowy sekret i natychmiast unieważnia poprzedni klucz. Zaktualizuj aplikację nowym kluczem przed zamknięciem jednorazowego okna z sekretem.
4. Unieważnij klucz
Unieważnij klucz, jeśli nie jest już potrzebny lub mógł zostać ujawniony. Przestaje działać natychmiast. Rekord unieważnionego klucza jest automatycznie usuwany po 7 dniach.
Zasady bezpieczeństwa
Nigdy nie udostępniaj klucza API, nie publikuj go w GitHubie, nie umieszczaj w kodzie JavaScript działającym w przeglądarce, nie wysyłaj go na zrzutach ekranu i nie zapisuj w publicznym kodzie. Przechowuj go w zmiennych środowiskowych serwera lub menedżerze sekretów. Jeśli klucz mógł zostać ujawniony, natychmiast go zregeneruj lub unieważnij.
Dostępne endpointy
| Metoda | Endpoint | Zastosowanie / opcje |
|---|---|---|
| GET | /v1/account/usage | Odczytuje plan konta, status klucza, dzienne użycie, pozostałą kwotę oraz wykorzystanie limitu żądań. |
| GET | /health | Publiczne sprawdzenie stanu i wersji API. |
| POST | /v1/pdf/to-word | Konwertuje prawidłowy plik PDF do Word. |
| POST | /v1/pdf/to-excel | Konwertuje prawidłowy plik PDF do Excel. |
| POST | /v1/image/to-text | Wyodrębnia tekst OCR z obrazu. Opcjonalne pole multipart: fast=true|false. |
| POST | /v1/image/to-word | Konwertuje obraz do Word. Opcjonalne pole multipart: fast=true|false. |
| POST | /v1/image/to-excel | Konwertuje obraz do Excel. Opcjonalne pole multipart: fast=true|false. |
| POST | /v1/image/remove-background | Usuwa tło obrazu. Opcjonalne pola: format (domyślnie png), transparent=true|false, fast_mode=true|false. |
Przykłady kodu
Obsługiwane pliki i walidacja
Endpointy PDF przyjmują rzeczywiste pliki PDF. Endpointy obrazów obsługują JPEG/JPG/JFIF, PNG, WebP, GIF, BMP oraz TIFF/TIF. API sprawdza zarówno rozszerzenie nazwy pliku, jak i rzeczywistą sygnaturę, dlatego samo przemianowanie nieobsługiwanego pliku nie omija walidacji.
Sposób zwracania odpowiedzi
Endpointy konwersji plików zwracają gotowy plik bezpośrednio do klienta. Image-to-text zwraca JSON. Wewnętrzne adresy pobierania konwerterów nie są udostępniane klientom API.
Błędy HTTP i ich znaczenie
| Status | Znaczenie | Typowa przyczyna / działanie |
|---|---|---|
| 401 | Brakujący, nieprawidłowy, wygasły lub unieważniony klucz API. | Sprawdź nagłówek X-API-Key. Jeśli klucz został unieważniony lub zregenerowany, zastąp go aktualnym sekretem. |
| 403 | Dostęp do API nie jest włączony. | Konto nie ma obecnie aktywnego uprawnienia Premium lub Pro. |
| 409 | Operacja na kluczu jest sprzeczna z jego aktualnym stanem. | Przykłady: próba utworzenia więcej niż 3 aktywnych kluczy albo regeneracja klucza, który nie jest aktywny. |
| 413 | Przesłany plik jest zbyt duży. | Użyj pliku mieszczącego się w limicie planu API (obecnie 200 MB). |
| 415 | Nieobsługiwany lub niezgodny typ danych. | Użyj obsługiwanego PDF lub obrazu i zachowaj prawidłowe rozszerzenie; API sprawdza również sygnaturę pliku. |
| 422 | Nieprawidłowa zawartość żądania. | Plik może być pusty albo wymagane dane multipart mogą być brakujące lub nieprawidłowe. |
| 429 | Zbyt wiele żądań. | Osiągnięto limit żądań na minutę albo wspólną dzienną kwotę konta. Spróbuj ponownie później lub poczekaj na dzienny reset. |
| 5xx | Tymczasowy błąd API lub usługi konwersji. | Ponów żądanie z opóźnieniem. Błędy infrastruktury/backendu nie są naliczane do dziennej kwoty. |
Jak liczona jest kwota
Dzienna kwota i limity żądań na minutę są współdzielone przez wszystkie klucze tego samego konta API. Nieprawidłowe lub nieobsługiwane pliki odrzucone przed uruchomieniem konwersji nie zużywają dziennej kwoty. Błędy serwera lub infrastruktury zwracają zarezerwowaną kwotę. Żądanie przyjęte do konwersji może zostać policzone nawet wtedy, gdy wewnętrzny konwerter później zwróci błąd klienta 4xx. Dzienna kwota resetuje się według dnia kalendarzowego serwera/bazy danych API.
Usage check: GET https://fileconvertfree.com/api1/v1/account/usage
Najczęstsze pytania
Czy konto Free może korzystać z API?
Nie. Dokumentacja jest dostępna publicznie, ale wywołania API wymagają obecnie aktywnego planu Premium lub Pro.
Czy utworzenie 3 kluczy potraja mój limit?
Nie. Wszystkie klucze korzystają ze wspólnych dziennych i minutowych limitów konta.
Czy można odzyskać utracony sekret?
Nie. Jawny sekret nie jest przechowywany. Zregeneruj klucz i zapisz nowy sekret.
Co się stanie po wygaśnięciu płatnego planu?
Dostęp do API zostaje wyłączony, gdy konto nie ma już aktywnego kwalifikującego planu. Odnów Premium lub Pro, aby ponownie uzyskać dostęp.
Gotowy na integrację FileConvertFree?
Utwórz klucz w Panelu, sprawdź go za pomocą endpointu usage, a następnie podłącz trasę konwersji potrzebną Twojej aplikacji.