Dzielenie pdf API
Dzielenie pdf API, PdfSplit łączy zadanie z Twoją aplikacją: wysyłasz plik, sprawdzasz stan zadania i pobierasz wynik. Punkty końcowe działają na serwerze – bez udziału przeglądarki.
Szybki start
- Utwórz klucz w sekcji Developer API (https://pixepi.com/pl/konto) na swoim koncie; klucz w postaci zwykłego tekstu jest widoczny tylko w momencie jego utworzenia.
- Wyślij zapytanie do https://api.pixepi.com z nagłówkiem Authorization: Bearer
. - Sprawdzaj stan zadania z odpowiedzi za pomocą GET https://api.pixepi.com/api/v1/jobs/{id}; gdy status zmieni się na done, pobierz wynik z adresu download_url.
Przykładowe żądanie
curl -X POST "https://api.pixepi.com/api/v1/apps/pdfsplit/run" \
-H "Authorization: Bearer $PIXEPI_KEY" \
-F "[email protected]" \
-F "options[mode]=pages" \
-F "options[page_range]=1-3"
curl -H "Authorization: Bearer $PIXEPI_KEY" "https://api.pixepi.com/api/v1/jobs/42"Endpointy tego narzędzia
| Metoda | Ścieżka | Działanie |
|---|---|---|
POST | /run | Uruchamia narzędzie, rozpoczyna zadanie i zwraca wynik. |
Opcje
Opcje przesyła się jako options[<field>]; puste pole przyjmuje wartość domyślną.
| Pole | Wartości | Domyślnie |
|---|---|---|
options[mode]Tryb dzielenia | pages · range · chunks | pages |
options[page_range]Zakresy stron | 1-3 | |
options[chunk_size]Rozmiar bloku | 1–500 | 5 |
options[merge_output]Połącz zakresy w jeden PDF | włączone · wyłączone | wyłączone |
Wspólne endpointy
| Metoda | Ścieżka | Działanie |
|---|---|---|
GET | /api/v1/apps | Katalog API |
GET | /api/v1/apps/pdfsplit | Kontrakt narzędzia |
GET | /api/v1/jobs/{id} | Status zadania |
GET | /api/v1/jobs/{id}/download | Pobierz wynik zadania |
GET | /api/v1/usage | Podsumowanie użycia |
GET | /api/v1/openapi.json | Dokument OpenAPI 3.1 |
Limity
- Maksymalnie 100 MB na plik.
- Informacje o limitach i planie są powiązane z twoim kontem; sprawdź bieżący stan za pomocą
GET /api/v1/usage.
Kody błędów
| Kod | Znaczenie |
|---|---|
unauthorized | Brak klucza API lub klucz jest nieprawidłowy. |
forbidden | Ta operacja jest niedozwolona dla tego klucza. |
not_found | Nie znaleziono narzędzia, zadania ani rekordu (404 również dla dostępu międzykontowego). |
invalid_input | Błąd walidacji danych (brakujące lub nieprawidłowe pole, błędna data itp.). |
invalid_request | Nieprawidłowe żądanie. |
too_large | Rozmiar pliku lub treści przekracza limit. |
unsupported_media | Nieobsługiwany typ pliku. |
not_supported | To narzędzie nie działa na tym punkcie końcowym (aplikacja stanowa). |
not_ready | Zadanie nie jest jeszcze zakończone. |
expired | Plik wyjściowy wygasł. |
no_output | Brak wyniku do pobrania dla tego zadania. |
invalid_path | Nieprawidłowa ścieżka wyjściowa. |
quota_exceeded | Przekroczono limit lub przydział. |
rate_limited | Zbyt wiele żądań w krótkim czasie; poczekaj chwilę i spróbuj ponownie. |
csrf | Weryfikacja formularza przeglądarki nie powiodła się (zewnętrzne API używa kluczy). |
conflict | Operacja koliduje z obecnym stanem. |
unavailable | Narzędzie jest tymczasowo niedostępne. |
internal_error | Nieoczekiwany błąd serwera. |
Dokumenty
Często zadawane pytania
Gdzie mogę uzyskać klucz API?
Utwórz klucz w sekcji API dla programistów na swoim koncie; klucz jest widoczny tylko raz, w momencie jego wygenerowania.
Jak wysłać zapytanie?
Punkty końcowe działają pod adresem https://api.pixepi.com; każde zapytanie wymaga nagłówka "Authorization: Bearer <klucz>".
Jakie pliki obsługuje API PdfSplit?
Obsługiwane formaty: PDF. Limit to 100 MB na plik; opcje są takie same jak na stronie narzędzia.
Jak interpretować odpowiedź z błędem?
Ciało błędu zawiera pola {ok:false, error, code, request_id}; wartości kodu znajdziesz w tabeli kodów błędów.