メインコンテンツまでスキップ

短縮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ドキュメントをレスポンスとして返します。失敗した場合のレスポンスについては、「エラーコード」セクションを参照してください。

パラメーター詳細/値
idmasked_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_urlhttps://<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>"
}