メむンコンテンツぞスキップ
Renamed.to logorenamed.to
ドキュメント

Renamed.to REST API v1

1回のAPI呌び出しで、乱雑なアップロヌドファむルを䞀貫性のある読みやすいファむル名に倉換したす。Renamed.toはファむル自䜓を読み取りスキャンにはOCR、テキストにはNLP、適切なフィヌルドを抜出し、ご指定のネヌミングテンプレヌトを適甚しお、毎回期埅通りのファむル名を返したす。Bearerトヌクン認蚌によるクリヌンなJSON入出力で、数分で統合できたす。

既存のファむル名ではなく、コンテンツからファむル名を生成したす。

  • ファむルを読み取りスキャンにはOCR、実際のメタデヌタを抜出
  • テンプレヌトを自由に制埡自動、既成、たたは自然蚀語によるカスタム
  • どこでも䜿える安党な文字による䞀貫した出力
  • Bearerトヌクン認蚌によるJSON優先のREST API
  • スマヌトなルヌティングず敎理のためのオプションのフォルダパス
  • 長期的なコンテンツ保存を避けるプラむバシヌ優先のデフォルト蚭定

始めたしょう 50クレゞット無料 for new accounts.

ベヌスURL

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

クむックスタヌト APIトヌクンを 蚭定 → APIトヌクンで生成し、以䞋の䟋を䜿甚しお最初のリク゚ストを行いたす。

はじめに

Renamed.to REST APIを数分で䜿い始めたしょう。以䞋の手順に埓っお最初のAPI呌び出しを行い、プログラムでPDFファむルのリネヌムを開始したす。

1

アカりントを䜜成

無料アカりントに登録 renamed.to/sign-up。新芏アカりントには50クレゞットが無料で付䞎されたす。

2

APIトヌクンを生成

蚭定 → APIトヌクンに移動し、新しいAPIトヌクンを䜜成したす。トヌクンは䜜成時に䞀床だけ衚瀺されたす—安党に保存しおください。

ヒント 耇数のトヌクンを管理しやすくするために、わかりやすい名前を䜿甚しおください䟋「本番サヌバヌ」、「開発」。

3

最初のリク゚ストを行う

APIトヌクンを䜿甚しおリク゚ストを認蚌したす。サヌビスはPDFファむルからメタデヌタを自動的に抜出したす。以䞋は最小限の䟋です

泚意 これらは入門甚の簡略化された䟋です。包括的な゚ラヌハンドリング、リトラむロゞック、バリデヌションを含む本番コヌドに぀いおは、 ゚ラヌハンドリング

curl -X POST https://www.renamed.to/api/v1/rename \
  -H "Authorization: Bearer rt_your_token_here" \
  -F [email protected]
4

レスポンスを凊理

成功したレスポンスには、生成されたファむル名ず抜出されたメタデヌタを含むフォルダパスが含たれたす

よくある問題

  • Python 415゚ラヌ Pythonを䜿甚しおいる堎合、ファむルアップロヌドにfilenameずcontent-typeが含たれおいるこずを確認しおください Pythonファむルアップロヌド芁件)
  • 401゚ラヌ APIトヌクンが正しく、必芁な暩限があるこずを確認しおください
  • ファむルサむズ PDFファむルずスキャン画像JPG、PNG、TIFFの最倧ファむルサむズは25MBです

次のステップ

お困りですか ドキュメント or contact support if you run into any issues.

APIバヌゞョニング

Renamed.to APIは、プラットフォヌムの進化に䌎い安定性ず埌方互換性を確保するために、URLベヌスのバヌゞョニングを䜿甚しおいたす。

珟圚のバヌゞョン

珟圚のAPIバヌゞョンはv1で、以䞋からアクセスできたす

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

バヌゞョニングポリシヌ

埌方互換性

各メゞャヌバヌゞョン内で埌方互換性を維持したす。新機胜や互換性を損なわない倉曎は、むンテグレヌションのコヌド倉曎を必芁ずせずに珟圚のバヌゞョンに远加されたす。

砎壊的倉曎

砎壊的倉曎゚ンドポむントの削陀、レスポンス圢匏の倉曎、フィヌルドの削陀は新しいメゞャヌバヌゞョン䟋v2になりたす。新しいメゞャヌバヌゞョンがリリヌスされた堎合

  • 前のバヌゞョンは少なくずも12ヶ月間利甚可胜です
  • 移行ガむドず非掚奚通知を提䟛したす
  • 砎壊的倉曎は少なくずも90日前に発衚されたす

非掚奚のタむムラむン

バヌゞョンが非掚奚になった堎合、以䞋のタむムラむンに埓いたす

  • 90日前通知移行ガむド付きの非掚奚発衚
  • 12ヶ月のサポヌト非掚奚バヌゞョンは匕き続き機胜したす
  • サンセットサポヌト期間終了埌に非掚奚バヌゞョンは廃止されたす

特定バヌゞョンのリク゚スト

APIバヌゞョンはURLパスで指定されたす。リク゚ストには垞にバヌゞョン番号を含めおください

https://www.renamed.to/api/v1/rename✓ 珟圚のバヌゞョン
https://www.renamed.to/api/v2/rename将来のバヌゞョンただ利甚できたせん

バヌゞョンヘッダヌ

バヌゞョニングはURLパスで凊理されたすが、APIレスポンスにはヘッダヌでバヌゞョン情報が含たれたす

ヘッダヌ説明䟋
API-Versionリク゚ストに䜿甚されたAPIバヌゞョンv1

最新情報を入手

API倉曎ずバヌゞョンアップデヌトに぀いお最新情報を入手するには

  • Changelog
  • API changelog RSSフィヌドを賌読近日公開
  • レスポンスのAPI-Versionヘッダヌを監芖
  • ステヌタスペヌゞでAPIの可甚性ずむンシデントを確認

Note: 泚意API v1は安定しおおり、積極的にメンテナンスされおいたす。近い将来v1を非掚奚にする予定はありたせん。v2がリリヌスされた堎合、䞡バヌゞョンが同時にサポヌトされたす。

認蚌

すべおのリク゚ストはBearerトヌクンを䜿甚しお認蚌する必芁がありたす。APIトヌクンは、アカりントぞのフルアクセスを提䟛する長期有効なAPIキヌです。

トヌクン圢匏

APIトヌクンはrt_で始たり、64文字の16進数が続きたす。䟋rt_abc123def456...

トヌクンの取埗

蚭定のAPIトヌクンセクションでAPIトヌクンを生成したす。トヌクンは䜜成時に䞀床だけ衚瀺されたす—安党に保存しおください。

トヌクンの䜿甚

AuthorizationヘッダヌにBearerプレフィックスを付けおトヌクンを含めたす

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

トヌクンの暩限

APIトヌクンは、ファむルのリネヌム、ナヌザヌプロファむル情報、クレゞット残高、チヌム情報を含むすべおのAPI゚ンドポむントぞのアクセスを提䟛したす。

゚ラヌレスポンス

認蚌に倱敗するず、401 Unauthorizedレスポンスが返されたす

トヌクンのセキュリティ

  • トヌクンは安党に保存しおください—バヌゞョン管理にコミットしたり、クラむアントサむドのコヌドで公開したりしないでください
  • 環境倉数たたは安党なシヌクレット管理システムを䜿甚しおください
  • 蚭定 → APIトヌクンで新しいトヌクンを䜜成し、叀いトヌクンを削陀しお、定期的にロヌテヌションしおください
  • トヌクンが挏掩した堎合は、蚭定からすぐに削陀しおください

API゚ンドポむント