POSTapi-shortUrl-create
短縮URL生成
短縮URL生成APIサービスを提供し、開発者が短縮URL関連情報を迅速に生成し、業務システムへ統合できるよう支援します。
導入ドキュメント
短縮URL生成APIの仕様
短縮URL生成APIは、開発者がシステム内で短縮URL生成に関する処理を迅速に完了できるよう支援します。構造化された結果を返すため、業務システムへの統合、自動化された呼び出し、システム連携などのシナリオに適しています。
適用シナリオ
- 内部システム、SaaSプラットフォーム、自動化ワークフロー、または運用管理画面への「短縮URL生成」機能の組み込みをサポートします。
- 安定した呼び出し、標準化されたレスポンス、およびオーケストレーション可能なAPI機能が必要な業務シナリオに適しています。
- 全体的な統合の安定性を向上させるため、リクエストの頻度制御、失敗時のリトライ、および結果のキャッシュ戦略と組み合わせることを推奨します。
導入時の推奨事項
- 導入前に、リクエストパラメータの形式、認証方法、およびエラーコードの処理ロジックを確認してください。
- 高頻度で「生成」を行うシナリオでは、ログ追跡、タイムアウト制御、およびべき等性の処理を適切に行うことを推奨します。
- 結果をリスク管理や自動意思決定に使用する場合は、APIのレスポンスのみに単一依存するのではなく、ビジネスルールと組み合わせた二次判断を行うことを推奨します。
実装サンプルコード
Shell、Python、Go、Java、PHP の呼び出し例をまとめ、既存プロジェクトに組み込みやすくしています。
リクエスト例
{}レスポンス例
{
"code": 200,
"data": {
"urlKey": {
"type": "string",
"example": "47ya"
},
"longUrl": {
"type": "string",
"example": "https://www.toolkk.com"
},
"orderNo": {
"type": "string",
"example": "453794735555611327"
},
"shortUrl": {
"type": "string",
"example": "kzu.cc/47ya"
},
"shortUrlHTTP": {
"type": "string",
"example": "http://kzu.cc/47ya"
},
"shortUrlHTTPS": {
"type": "string",
"example": "https://kzu.cc/47ya"
}
},
"message": "success"
}レスポンス項目
以下の項目はサンプル JSON から自動抽出した参考情報です。
| パス | 型 | サンプル値 |
|---|---|---|
| code | number | 200 |
| data | object | {...} |
| data.urlKey | object | {...} |
| data.urlKey.type | string | string |
| data.urlKey.example | string | 47ya |
| data.longUrl | object | {...} |
| data.longUrl.type | string | string |
| data.longUrl.example |