APIドキュメント
シンプルなREST APIでly1.ru URL短縮をアプリケーションに統合。
🔐 認証が必要
APIアクセスには認証が必要です。GoogleでログインしてAPIキーを取得してください。 ログイン
認証
すべてのAPIリクエストにはAPIキーによる認証が必要です。ヘッダーに含めてください:
Authorization: Bearer YOUR_API_KEY
またはヘッダーを使用 X-API-Key :
X-API-Key: YOUR_API_KEY
エンドポイント
POST
/api/v1/shorten
短縮URLを作成。
リクエストパラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
| url 必須 | string | 短縮するURL(有効なHTTP/HTTPS URLである必要があります) |
| custom 任意 | string | カスタムエイリアス(3-32文字の英数字) |
リクエスト例
# Using curl
curl -X POST https://ly1.ru/api/v1/shorten \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url": "https://example.com/very/long/url", "custom": "mylink"}'
# Using PHP
$ch = curl_init('https://ly1.ru/api/v1/shorten');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_API_KEY',
'Content-Type: application/json'
],
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://example.com/very/long/url',
'custom' => 'mylink'
])
]);
$response = json_decode(curl_exec($ch), true);
成功レスポンス (200)
{
"success": true,
"data": {
"code": "mylink",
"short_url": "https://ly1.ru/mylink",
"subdomain_url": "https://mylink.ly1.ru",
"original_url": "https://example.com/very/long/url"
}
}
エラーレスポンス (400/401)
{
"success": false,
"error": "Error message here"
}
エラーコード
| Code | 説明 |
|---|---|
400 |
不正なリクエスト — 無効なパラメータまたはURL |
401 |
未認証 — 無効または欠落したAPIキー |
405 |
メソッド不許可 — POSTを使用してください |
500 |
サーバー内部エラー |
レート制限
現在、厳密な制限はありませんが、適度にご利用ください。過度なリクエストは一時的なブロックにつながる可能性があります。