有効な短縮URLのリスト

詳細

短縮URLのリストを取得するためには、GETメソッドで” SHORT URL”エンドポイントにリクエストする必要があります。

エンドポイントURL: https://api.cpaas.symphony.rakuten.net/short-url/v1/query/url

メソッド: GET

HTTP ヘッダー

パラメーター	要否	値
Authentication	必須	Type: Bearer Token: JWT Token
Accept	必須	application/json
Content-Type	必須	application/json; charset=UTF-8

サンプルレスポンス

成功した場合、APIコールはHTTP 200 OKとJSONドキュメントをレスポンスとして返します。失敗した場合のレスポンスについては、「エラーコード」セクションを参照してください。

HTTP ヘッダー

パラメーター	要否	値
Content-Type	値	application/hal+json; charset=UTF-8

JSON ヘッダー

パラメーター	値
page_size	デフォルトページサイズ: 10
page	表示される項目の数
total_found	マスクされたURLの数
masked_urls	マスクされたURLの詳細

サンプルレスポンス

{
  "page_size":10,
  "page":1,
  "_links":{
    "self":{
      "href":"/short-url/v1/query/url?page=1&page-size=10"
    },
    "first":{
      "href":"/short-url/v1/query/url?page=1&page-size=10"
    },
    "last":{
      "href":"/short-url/v1/query/url?page=1&page-size=10"
    }
  },
  "_embedded":{
    "total_found":1,
    "masked_urls":[
      {
        "id":"pIAr0F",
        "remote_url":"https://www.example.com",
        "name":"Example",
        "description":"Example Short URL",
        "valid_until_date":"2024-06-01 07:31:00",
        "date_created":"2024-05-30 08:46:01",
        "time_last_updated":"2024-05-30 08:47:24",
        "public_masked_url":"https://<api.hostname>/pIAr0F",
        "_links":{
          "self":{
            "href":"/short-url/v1/url/pIAr0F"
          }
        }
      }
    ]
  }
}

短縮URLが見つからない場合

{
  "page_size": 10,
  "page": 1,
  "_links": {
    "self": {
      "href": "/short-url/v1/query/url?page=1&page-size=10"
    },
    "first": {
      "href": "/short-url/v1/query/url?page=1&page-size=10"
    },
    "last": {
      "href": "/short-url/v1/query/url?page=1&page-size=10"
    }
  },
  "_embedded": {
    "total_found": 0,
    "masked_urls": []
  }
}