Documentation/REST API

API REST Renamed.to v1

Transformez les téléchargements désordonnés en noms de fichiers cohérents et lisibles avec un seul appel API. Renamed.to lit le fichier lui-même (OCR pour les scans, NLP pour le texte) pour extraire les bons champs, puis applique votre modèle de nommage pour retourner exactement le nom de fichier que vous attendez—à chaque fois. JSON propre en entrée/sortie avec authentification par jeton Bearer, pour une intégration en quelques minutes.

Renommez les fichiers à partir de leur contenu, pas de leurs noms existants.

  • Lit le fichier (OCR pour les scans) pour extraire les métadonnées réelles
  • Modèles que vous contrôlez : auto, prêts à l'emploi ou personnalisés en langage naturel
  • Sortie cohérente et sûre avec des caractères qui fonctionnent partout
  • API REST JSON-first avec authentification par jeton Bearer
  • Chemin de dossier optionnel pour routage et organisation intelligents
  • Paramètres de confidentialité par défaut qui évitent le stockage de contenu à long terme

Pour commencer : 50 crédits gratuits for new accounts.

URL de Base

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

Démarrage Rapide : Générez un jeton API dans Paramètres → Jetons API, puis effectuez votre première requête en utilisant les exemples ci-dessous.

Pour Commencer

Démarrez avec l'API REST Renamed.to en quelques minutes. Suivez ces étapes pour effectuer votre premier appel API et commencer à renommer des fichiers PDF de manière programmatique.

1

Créer un Compte

Inscrivez-vous pour un compte gratuit sur renamed.to/sign-up. Les nouveaux comptes reçoivent 50 crédits gratuits pour commencer.

2

Générer un Jeton API

Naviguez vers Paramètres → Jetons APIet créez un nouveau jeton API. Les jetons ne sont affichés qu'une seule fois lors de leur création—assurez-vous de le sauvegarder en toute sécurité.

Conseil : Utilisez des noms descriptifs pour vos jetons (par ex., 'Serveur de Production', 'Développement') pour aider à gérer plusieurs jetons.

3

Effectuez Votre Première Requête

Utilisez votre jeton API pour authentifier les requêtes. Le service extraira automatiquement les métadonnées de vos fichiers PDF. Voici un exemple minimal :

Note : Ce sont des exemples simplifiés pour débuter. Pour du code de production avec gestion complète des erreurs, logique de nouvelle tentative et validation, voir la Gestion des Erreurs

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

Gérer la Réponse

Une réponse réussie inclut le nom de fichier généré et le chemin de dossier avec les métadonnées extraites :

Problèmes Courants

  • Erreur Python 415 : Si vous utilisez Python, assurez-vous que les téléchargements de fichiers incluent le nom de fichier et le content-type (voir Exigences de Téléchargement de Fichiers Python)
  • Erreurs 401 : Vérifiez que votre jeton API est correct et possède les permissions nécessaires
  • Taille de Fichier : La taille maximale de fichier est de 25 Mo pour les fichiers PDF et images scannées (JPG, PNG, TIFF)

Prochaines Étapes

Besoin d'aide ? Consultez notre documentation or contact support if you run into any issues.

Versionnage API

L'API Renamed.to utilise le versionnage basé sur l'URL pour garantir la stabilité et la compatibilité ascendante à mesure que nous faisons évoluer la plateforme.

Version Actuelle

La version actuelle de l'API est v1, accessible à :

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

Politique de Versionnage

Compatibilité Ascendante

Nous maintenons la compatibilité ascendante au sein de chaque version majeure. Les nouvelles fonctionnalités et les modifications non cassantes sont ajoutées à la version actuelle sans nécessiter de changements de code dans votre intégration.

Modifications Cassantes

Les modifications cassantes (points d'accès supprimés, formats de réponse modifiés, champs supprimés) entraîneront une nouvelle version majeure (par ex., v2). Lorsqu'une nouvelle version majeure est publiée :

  • La version précédente reste disponible pendant au moins 12 mois
  • Nous fournissons des guides de migration et des avis de dépréciation
  • Les modifications cassantes sont annoncées au moins 90 jours à l'avance

Calendrier de Dépréciation

Lorsqu'une version est dépréciée, nous suivons ce calendrier :

  • Avis de 90 jours : Annonce de dépréciation avec guide de migration
  • Support de 12 mois : La version dépréciée reste fonctionnelle
  • Fin de vie : La version dépréciée est retirée après la période de support

Demander une Version Spécifique

La version de l'API est spécifiée dans le chemin de l'URL. Incluez toujours le numéro de version dans vos requêtes :

https://www.renamed.to/api/v1/rename✓ Version actuelle
https://www.renamed.to/api/v2/renameVersion future (pas encore disponible)

En-têtes de Version

Bien que le versionnage soit géré via le chemin URL, les réponses API incluent des informations de version dans les en-têtes :

En-têteDescriptionExemple
API-VersionLa version de l'API utilisée pour la requêtev1

Rester à Jour

Pour rester informé des changements API et des mises à jour de version :

  • Consultez le Changelog
  • Abonnez-vous à notre flux RSS changelog API (à venir)
  • Surveillez l'en-tête API-Version dans les réponses
  • Suivez notre page de statut pour la disponibilité API et les incidents

Note: Note : L'API v1 est stable et activement maintenue. Nous n'avons pas de plans pour déprécier v1 dans un avenir proche. Lorsque v2 sera publiée, les deux versions seront supportées simultanément.

Authentification

Chaque requête doit être authentifiée en utilisant un jeton Bearer. Les jetons API sont des clés API de longue durée qui fournissent un accès complet à votre compte.

Format de Jeton

Les jetons API sont préfixés avec rt_ suivi de 64 caractères hexadécimaux. Exemple : rt_abc123def456...

Obtenir Votre Jeton

Générez des jetons API dans la section Jetons API de vos paramètres. Les jetons ne sont affichés qu'une seule fois lors de leur création—assurez-vous de les sauvegarder en toute sécurité.

Utiliser Votre Jeton

Incluez votre jeton dans l'en-tête Authorization avec le préfixe Bearer :

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

Permissions des Jetons

Les jetons API fournissent l'accès à tous les points d'accès API, y compris le renommage de fichiers, les informations de profil utilisateur, le solde de crédits et les informations d'équipe.

Réponses d'Erreur

Si l'authentification échoue, vous recevrez une réponse 401 Unauthorized :

Sécurité des Jetons

  • Stockez les jetons en toute sécurité—ne les validez jamais dans le contrôle de version ou ne les exposez pas dans le code côté client
  • Utilisez des variables d'environnement ou des systèmes de gestion de secrets sécurisés
  • Faites tourner les jetons régulièrement en créant de nouveaux jetons et en supprimant les anciens depuis Paramètres → Jetons API
  • Si un jeton est compromis, supprimez-le immédiatement depuis vos paramètres

Points d'Accès API