Dokumentation/REST API

Renamed.to REST API v1

Verwandeln Sie unordentliche Uploads mit einem einzigen API-Aufruf in konsistente, lesbare Dateinamen. Renamed.to liest die Datei selbst (OCR für Scans, NLP für Text) um die richtigen Felder zu extrahieren und wendet dann Ihre Benennungsvorlage an, um den exakten Dateinamen zurückzugeben, den Sie erwarten – jedes Mal. Sauberes JSON-Ein-/Ausgabe mit Bearer-Token-Authentifizierung, damit Sie in Minuten integrieren können.

Dateien nach ihrem Inhalt umbenennen, nicht nach ihren bestehenden Namen.

  • Liest die Datei (OCR für Scans) um echte Metadaten zu extrahieren
  • Vorlagen nach Wahl: automatisch, vorgefertigt oder benutzerdefiniert in natürlicher Sprache
  • Konsistente, sichere Ausgabe mit Zeichen, die überall funktionieren
  • JSON-first REST API mit Bearer-Token-Authentifizierung
  • Optionaler Ordnerpfad für intelligentes Routing und Organisation
  • Datenschutz-orientierte Standardeinstellungen, die langfristige Inhaltsspeicherung vermeiden

Jetzt starten: 50 kostenlose Credits für neue Konten.

Basis-URL

https://www.renamed.to/api/v1

Schnellstart: Generieren Sie einen API-Token unter Einstellungen → API-Tokens, dann führen Sie Ihre erste Anfrage mit den folgenden Beispielen aus.

Erste Schritte

Starten Sie mit der Renamed.to REST API in wenigen Minuten. Folgen Sie diesen Schritten, um Ihren ersten API-Aufruf zu machen und PDFs programmatisch umzubenennen.

1

Konto erstellen

Registrieren Sie sich für ein kostenloses Konto unter renamed.to/sign-up. Neue Konten erhalten 50 kostenlose Credits zum Starten.

2

API-Token generieren

Navigieren Sie zu Einstellungen → API-Tokensund erstellen Sie einen neuen API-Token. Tokens werden nur einmal bei der Erstellung angezeigt – speichern Sie ihn sicher.

Tipp: Verwenden Sie beschreibende Namen für Ihre Tokens (z.B. "Produktionsserver", "Entwicklung") um mehrere Tokens zu verwalten.

3

Erste Anfrage durchführen

Verwenden Sie Ihren API-Token zur Authentifizierung. Der Dienst extrahiert automatisch Metadaten aus Ihren PDF-Dateien. Hier ein minimales Beispiel:

Hinweis: Dies sind vereinfachte Beispiele für den Einstieg. Für Produktionscode mit umfassender Fehlerbehandlung, Wiederholungslogik und Validierung siehe Fehlerbehandlung

curl -X POST https://www.renamed.to/api/v1/rename \
  -H "Authorization: Bearer rt_your_token_here" \
  -F file=@invoice.pdf
4

Antwort verarbeiten

Eine erfolgreiche Antwort enthält den generierten Dateinamen und Ordnerpfad mit extrahierten Metadaten:

Häufige Probleme

  • Python 415 Fehler: Bei Verwendung von Python stellen Sie sicher, dass Datei-Uploads Dateinamen und Content-Type enthalten (siehe Python Datei-Upload-Anforderungen)
  • 401 Fehler: Überprüfen Sie, ob Ihr API-Token korrekt ist und die erforderlichen Berechtigungen hat
  • Dateigröße: Maximale Dateigröße beträgt 25 MB für PDF-Dateien und gescannte Bilder (JPG, PNG, TIFF)

Nächste Schritte

Hilfe benötigt? Besuchen Sie unsere Dokumentation oder kontaktieren Sie den Support bei Problemen.

API-Versionierung

Die Renamed.to API verwendet URL-basierte Versionierung, um Stabilität und Abwärtskompatibilität bei der Weiterentwicklung der Plattform zu gewährleisten.

Aktuelle Version

Die aktuelle API-Version ist v1, erreichbar unter:

https://www.renamed.to/api/v1

Versionierungsrichtlinie

Abwärtskompatibilität

Wir gewährleisten Abwärtskompatibilität innerhalb jeder Hauptversion. Neue Funktionen und nicht-brechende Änderungen werden zur aktuellen Version hinzugefügt, ohne dass Codeänderungen in Ihrer Integration erforderlich sind.

Brechende Änderungen

Brechende Änderungen (entfernte Endpunkte, geänderte Antwortformate, entfernte Felder) führen zu einer neuen Hauptversion (z.B. v2). Wenn eine neue Hauptversion veröffentlicht wird:

  • Die vorherige Version bleibt mindestens 12 Monate verfügbar
  • Wir stellen Migrationsanleitungen und Deprecation-Hinweise bereit
  • Brechende Änderungen werden mindestens 90 Tage im Voraus angekündigt

Deprecation-Zeitplan

Wenn eine Version veraltet ist, folgen wir diesem Zeitplan:

  • 90 Tage Vorankündigung: Deprecation-Ankündigung mit Migrationsanleitung
  • 12 Monate Unterstützung: Veraltete Version bleibt funktionsfähig
  • Sunset: Veraltete Version wird nach der Unterstützungsperiode eingestellt

Spezifische Version anfordern

Die API-Version wird im URL-Pfad angegeben. Fügen Sie immer die Versionsnummer in Ihre Anfragen ein:

https://www.renamed.to/api/v1/rename✓ Aktuelle Version
https://www.renamed.to/api/v2/renameZukünftige Version (noch nicht verfügbar)

Versions-Header

Während die Versionierung über den URL-Pfad erfolgt, enthalten API-Antworten Versionsinformationen in Headern:

HeaderBeschreibungBeispiel
API-VersionDie für die Anfrage verwendete API-Versionv1

Auf dem Laufenden bleiben

Um über API-Änderungen und Versionsaktualisierungen informiert zu bleiben:

  • Überprüfen Sie das Changelog
  • Abonnieren Sie unseren API-Changelog RSS-Feed (demnächst verfügbar)
  • Überwachen Sie den API-Version Header in Antworten
  • Folgen Sie unserer Statusseite für API-Verfügbarkeit und Vorfälle

Hinweis: Hinweis: API v1 ist stabil und wird aktiv gepflegt. Wir haben keine Pläne, v1 in naher Zukunft zu deprecaten. Wenn v2 veröffentlicht wird, werden beide Versionen gleichzeitig unterstützt.

Authentifizierung

Jede Anfrage muss mit einem Bearer-Token authentifiziert werden. API-Tokens sind langlebige API-Schlüssel, die vollen Zugriff auf Ihr Konto bieten.

Token-Format

API-Tokens haben das Präfix rt_ gefolgt von 64 hexadezimalen Zeichen. Beispiel: rt_abc123def456...

Token erhalten

Generieren Sie API-Tokens im Bereich API-Tokens Ihrer Einstellungen. Tokens werden nur einmal bei der Erstellung angezeigt – speichern Sie sie sicher.

Token verwenden

Fügen Sie Ihren Token im Authorization-Header mit dem Bearer-Präfix ein:

curl -X GET https://www.renamed.to/api/v1/user \
  -H "Authorization: Bearer rt_your_token_here"

Token-Berechtigungen

API-Tokens bieten Zugriff auf alle API-Endpunkte, einschließlich Dateiumbenennung, Benutzerprofilinformationen, Credit-Guthaben und Team-Informationen.

Fehlerantworten

Wenn die Authentifizierung fehlschlägt, erhalten Sie eine 401 Unauthorized Antwort:

Token-Sicherheit

  • Speichern Sie Tokens sicher – committen Sie sie niemals in die Versionskontrolle und exponieren Sie sie nicht im clientseitigen Code
  • Verwenden Sie Umgebungsvariablen oder sichere Geheimnisverwaltungssysteme
  • Rotieren Sie Tokens regelmäßig, indem Sie neue erstellen und alte unter Einstellungen → API-Tokens löschen
  • Wenn ein Token kompromittiert wurde, löschen Sie ihn sofort aus Ihren Einstellungen

API-Endpunkte