開発者連携
公式SDK
数行のコードでPDFのリネーム、ドキュメントへの分割、データ抽出を行うための公式SDKです。
- インストール対象 TypeScript、Python、Go、Java、C#、Ruby、Rust、Swift、PHP
- SDK間で同じメソッド名を使用できます:
rename,pdfSplit,extract - renamed.toチームが保守するMITライセンスのオープンソースSDK
すべてのSDKに含まれる機能
- AIによるファイル名変更
- 境界検出によるPDF分割
- 構造化データ抽出
- 自動リトライとエラー処理
言語を選択
言語をクリックすると、インストール手順とコード例を表示します。
TypeScript / Node.js
Full TypeScript support with type definitions included.
npm install @renamed/sdkPython
Works with Python 3.8+ and async/await.
pip install renamedGo
Idiomatic Go with context support.
go get github.com/renamed-to/renamed-sdk/sdks/goRuby
Ruby 2.7+ with Rails integration.
gem install renamedPHP
PHP 8.0+ with PSR-18 HTTP client.
composer require renamed/sdkC# / .NET
.NET 6+ with async/await patterns.
dotnet add package Renamed.SdkRust
Async Rust with tokio runtime.
cargo add renamedJava
Java 11+ with CompletableFuture.
to.renamed:renamed-sdk:0.1.0Swift
Swift Package Manager for iOS and server-side Swift.
.package(url: "https://github.com/renamed-to/renamed-sdk", from: "0.1.0")クイックスタート例
すべてのSDKは同じパターンに従っています。一般的な言語での例を紹介します。
TypeScript
TypeScript
import { RenamedClient } from '@renamed/sdk'const client = new RenamedClient({ apiKey: process.env.RENAMED_API_KEY,})const result = await client.rename(pdfBuffer)console.log(result.suggestedFilename)Python
Python
from renamed import RenamedClientclient = RenamedClient(api_key=os.environ["RENAMED_API_KEY"])result = client.rename(pdf_bytes)print(result.suggested_filename)Go
Go
client := renamed.NewClient(os.Getenv("RENAMED_API_KEY"))result, _ := client.Rename(ctx, pdfBytes)fmt.Println(result.SuggestedFilename)例は簡略化しています。詳細は各言語のページをご覧ください。
SDKとREST APIの比較
連携要件に適したアプローチを選んでください。
次のような場合はSDKを使用
- 型安全性を備えたその言語らしいAPI
- 組み込みのリトライとエラー処理
- 初回成功までの時間を短縮
- バージョン管理されたパッケージで保守が容易
次のような場合はRESTを使用
- 公式SDKがない言語を使う場合
- 依存関係を最小限にしたい場合
- カスタムのリトライやキャッシュロジックが必要な場合
- 特殊なケースでHTTPを直接制御したい場合
GitHubの完全なSDKドキュメント
包括的なドキュメント、高度な例、コントリビューションガイドラインについては、renamed-sdkリポジトリ内の各言語のREADMEを参照してください。
よくある質問
- どのSDKを使うべきですか？
- 主に使用するプログラミング言語向けのSDKを選んでください。すべてのSDKは同じ機能を提供し、類似したAPIパターンに従っています。
- SDKはオープンソースですか？
- はい、すべてのSDKはMITライセンスで、GitHubで公開されています。コントリビューションも歓迎しています。
- 代わりにREST APIを直接使えますか？
- はい、すべてのAPIはBearer token認証によるREST経由で利用できます。SDKはREST APIの利便性を高めるラッパーです。
- SDKではどのようなメソッドが提供されていますか？
- すべてのSDKで同じ主要メソッドを提供しています。AIによるファイル名変更用のrename()、複数ページのPDFを分割するpdfSplit()、構造化データを抽出するextract()、アカウント情報を取得するgetUser()、処理済みファイルをダウンロードするdownloadFile()です。