短縮URLの詳細を取得
詳細
短縮URLの詳細を取得するためには、”masked_url_id” ともにGETメソッドで” SHORT URL”エンドポイントにリクエストする必要があります。
エンドポイントURL: https://api.cpaas.symphony.rakuten.net/short-url/v1/url/$masked_url_id
メソッド: GET
HTTP ヘッダー
パラメーター | 要否 | 値 |
---|---|---|
Authentication | 必須 | Type: Bearer Token: JWT Token |
Accept | 必須 | application/json |
Content-Type | 必須 | application/json; charset=UTF-8 |
レスポンス:
成功した場合、APIコールはHTTP 200 OKとJSONドキュメントをレスポンスとして返します。失敗した場合のレスポンスについては、「エラーコード」セクションを参照してください。
パラメーター | 詳細/値 |
---|---|
id | masked_url_id |
remote_url | 対象となるURL |
name | 短縮URLの名前 |
description | 短縮URLの概要 |
valid_until_date | 有効期限の日付形式はyyyy-MM-dd HH:mm:ss |
date_created | 作成日の日付形式はyyyy-MM-dd HH:mm:ss |
time_last_updated | 最終更新日の日付形式はyyyy-MM-dd HH:mm:ss |
public_masked_url | https://<api.hostname>/<masked_url_id> |
サンプルレスポンス
{
"id": "masked_url_id",
"remote_url": "...Destination URL...",
"name": "...Name of Short URL...",
"description": "...Description of Short URL...",
"valid_until_date": "...Valid until date in yyyy-MM-dd HH:mm:ss...",
"date_created": "...Date created in yyyy-MM-dd HH:mm:ss...",
"time_last_updated": "...Short URL last updated in yyyy-MM-dd HH:mm:ss...",
"public_masked_url": "https://<api.hostname>/<masked_url_id>"
}