Renamed.to REST API v1
Przekształć nieuporządkowane przesyłki w spójne, czytelne nazwy plików jednym wywołaniem API. Renamed.to odczytuje sam plik (OCR dla skanów, NLP dla tekstu), aby wyodrębnić właściwe pola, następnie stosuje szablon nazewnictwa, aby zwrócić dokładną nazwę pliku, jakiej oczekujesz—za każdym razem. Czysty JSON wejście/wyjście z uwierzytelnianiem przez token Bearer, dzięki czemu możesz zintegrować w kilka minut.
Zmieniaj nazwy plików na podstawie ich zawartości, a nie istniejących nazw.
- Odczytuje plik (OCR dla skanów), aby wyodrębnić rzeczywiste metadane
- Szablony, które kontrolujesz: automatyczne, wstępnie zdefiniowane lub niestandardowe w języku naturalnym
- Spójne, bezpieczne wyjście ze znakami, które działają wszędzie
- REST API oparte na JSON z uwierzytelnianiem przez token Bearer
- Opcjonalna ścieżka folderu do inteligentnego routingu i organizacji
- Ustawienia domyślne dbające o prywatność, które unikają długoterminowego przechowywania zawartości
Aby rozpocząć: 50 darmowych kredytów for new accounts.
Bazowy URL
Szybki start: Wygeneruj token API w Ustawienia → Tokeny API, następnie wykonaj swoje pierwsze żądanie używając poniższych przykładów.
Pierwsze kroki
Uruchom i używaj REST API Renamed.to w kilka minut. Postępuj zgodnie z tymi krokami, aby wykonać swoje pierwsze wywołanie API i rozpocząć programową zmianę nazw plików PDF.
Utwórz konto
Zarejestruj się na darmowe konto na renamed.to/sign-up. Nowe konta otrzymują 50 darmowych kredytów na start.
Wygeneruj token API
Przejdź do Ustawienia → Tokeny APIi utwórz nowy token API. Tokeny są wyświetlane tylko raz podczas tworzenia—upewnij się, że zapisałeś go bezpiecznie.
Wskazówka: Używaj opisowych nazw dla tokenów (np. "Serwer produkcyjny", "Rozwój"), aby pomóc w zarządzaniu wieloma tokenami.
Wykonaj swoje pierwsze żądanie
Użyj tokenu API do uwierzytelniania żądań. Usługa automatycznie wyodrębni metadane z plików PDF. Oto minimalny przykład:
Uwaga: To uproszczone przykłady do rozpoczęcia. Dla kodu produkcyjnego z pełną obsługą błędów, logiką ponownych prób i walidacją zobacz sekcję Obsługa błędów
curl -X POST https://www.renamed.to/api/v1/rename \
-H "Authorization: Bearer rt_your_token_here" \
-F file=@invoice.pdfObsłuż odpowiedź
Pomyślna odpowiedź zawiera wygenerowaną nazwę pliku i ścieżkę folderu z wyodrębnionymi metadanymi:
Typowe problemy
- Błąd 415 Python: Jeśli używasz Pythona, upewnij się, że przesyłane pliki zawierają nazwę pliku i typ zawartości (zobacz Wymagania przesyłania plików Python)
- Błędy 401: Sprawdź, czy token API jest poprawny i ma niezbędne uprawnienia
- Rozmiar pliku: Maksymalny rozmiar pliku to 25 MB dla plików PDF i zeskanowanych obrazów (JPG, PNG, TIFF)
Następne kroki
- Przeczytaj sekcję Uwierzytelnianie
- Poznaj punkt końcowy Rename
- Przejrzyj Obsługę błędów
- Zapoznaj się z Przykładami przypadków użycia
- Zobacz sekcję Rozwiązywanie problemów
Potrzebujesz pomocy? Zobacz naszą dokumentację or contact support if you run into any issues.
Wersjonowanie API
API Renamed.to używa wersjonowania opartego na URL, aby zapewnić stabilność i kompatybilność wsteczną w miarę rozwoju platformy.
Aktualna wersja
Aktualna wersja API to v1, dostępna na:
https://www.renamed.to/api/v1Polityka wersjonowania
Kompatybilność wsteczna
Utrzymujemy kompatybilność wsteczną w ramach każdej wersji głównej. Nowe funkcje i nieniszczące zmiany są dodawane do bieżącej wersji bez wymagania zmian w kodzie integracji.
Zmiany niszczące
Zmiany niszczące (usunięte punkty końcowe, zmienione formaty odpowiedzi, usunięte pola) skutkują nową wersją główną (np. v2). Gdy zostanie wydana nowa wersja główna:
- Poprzednia wersja pozostaje dostępna przez co najmniej 12 miesięcy
- Dostarczamy przewodniki migracji i ostrzeżenia o przestarzałych funkcjach
- Zmiany niszczące są ogłaszane z co najmniej 90-dniowym wyprzedzeniem
Harmonogram wycofywania
Gdy wersja zostaje wycofana, postępujemy według tego harmonogramu:
- 90 dni wyprzedzenia: Ogłoszenie wycofania z przewodnikiem migracji
- 12 miesięcy wsparcia: Wycofana wersja pozostaje funkcjonalna
- Wycofanie: Wycofana wersja jest usuwana po okresie wsparcia
Żądanie konkretnej wersji
Wersja API jest określona w ścieżce URL. Zawsze uwzględniaj numer wersji w żądaniach:
https://www.renamed.to/api/v1/rename✓ Aktualna wersjahttps://www.renamed.to/api/v2/renamePrzyszła wersja (jeszcze niedostępna)Nagłówki wersji
Podczas gdy wersjonowanie jest zarządzane przez ścieżkę URL, odpowiedzi API zawierają informacje o wersji w nagłówkach:
| Nagłówek | Opis | Przykład |
|---|---|---|
API-Version | Wersja API używana dla żądania | v1 |
Bycie na bieżąco
Aby być informowanym o zmianach API i aktualizacjach wersji:
- Zobacz Changelog
- Subskrybuj nasz kanał RSS changelog API (wkrótce)
- Monitoruj nagłówek API-Version w odpowiedziach
- Śledź naszą stronę statusu dla dostępności API i incydentów
Note: Uwaga: API v1 jest stabilne i aktywnie utrzymywane. Nie mamy planów wycofania v1 w najbliższej przyszłości. Gdy v2 zostanie wydana, obie wersje będą obsługiwane równocześnie.
Uwierzytelnianie
Każde żądanie musi być uwierzytelnione za pomocą tokenu Bearer. Tokeny API to długotrwałe klucze API zapewniające pełny dostęp do konta.
Format tokenu
Tokeny API mają prefiks rt_ po którym następuje 64 znaki szesnastkowe. Przykład: rt_abc123def456...
Uzyskiwanie tokenu
Generuj tokeny API w sekcji Tokeny API w ustawieniach. Tokeny są wyświetlane tylko raz podczas tworzenia—upewnij się, że zapisałeś je bezpiecznie.
Używanie tokenu
Dołącz token w nagłówku Authorization z prefiksem Bearer:
curl -X GET https://www.renamed.to/api/v1/user \
-H "Authorization: Bearer rt_your_token_here"Uprawnienia tokenu
Tokeny API zapewniają dostęp do wszystkich punktów końcowych API, w tym zmiany nazw plików, informacji o profilu użytkownika, saldzie kredytów i informacjach o zespole.
Odpowiedzi błędów
Jeśli uwierzytelnianie się nie powiedzie, otrzymasz odpowiedź 401 Unauthorized:
Bezpieczeństwo tokenu
- Przechowuj tokeny bezpiecznie—nigdy nie commituj ich do kontroli wersji ani nie ujawniaj w kodzie po stronie klienta
- Używaj zmiennych środowiskowych lub bezpiecznych systemów zarządzania tajemnicami
- Regularnie rotuj tokeny, tworząc nowe tokeny i usuwając stare z Ustawienia → Tokeny API
- Jeśli token został skompromitowany, natychmiast usuń go z ustawień
Punkty końcowe API
Punkt końcowy Rename
Zmieniaj nazwy plików PDF i zeskanowanych obrazów używając metadanych wyodrębnionych przez AI.
Punkt końcowy PDF Split
Dziel wielostronicowe pliki PDF na pojedyncze dokumenty z automatycznym nazewnictwem.
Konto i zasoby
Zarządzaj profilami użytkowników, sprawdzaj salda kredytów i członkostwo w zespole.
Dokumentacja i rozwiązywanie problemów
Kody błędów, limity szybkości, przewodniki rozwiązywania problemów i FAQ.