URL3.RU : Добавьте ниже длинную ссылку чтобы сократить.

API-запросы

обзор

Наш API позволяет Вам обеспечивать короткую функциональность URL для любого из Ваших существующих веб-сайтов. Когда Вы регистрируетесь для учетной записи, Вы сгенерированы уникальный ключ API, который должен использоваться в упомянутых ниже вызовах API.

Примеры ниже генерируют ответы в json, но Вы можете также использовать xml, заменяя конец вызова URL с .xml.

Создать

Создайте новую короткую ссылку, обеспечивающий закодированную версию base64 исходной полной ссылки .

параметры:
имя: тип: Описание:
key условие Ваш ключ доступа к API Вход для просмотра.
url условие Base64 кодируется версия длинной ссылки. base64_encode() в PHP.
Return Values:
имя: тип: Описание:
url_id целое Уникальный идентификатор URL.
short_url условие Короткий URL, включая доменное имя.
short_url_part условие Короткая часть url. (Исключая доменное имя)
original_url условие Оригинальный декодированный длинный URL-адрес.
date_time условие Дата и время вызова API. В формате yyyy-mm-dd hh:mm:ss.
Пример запроса:
API адрес: https://url3.ru
GET //api/v1/8faf3b3e66440013eb1e543ae95763ca/shorturl/create/url/BASE64_ENCODED_LONG_URL.json
Пример ответа:
{
   "code":200,
   "data":{
      "url_id":"1388597",
      "short_url":"https://url3.ru/srt",
      "short_url_part":"srt",
      "original_url":"http://www.bbc.co.uk",
      "date_time":"2013-04-04 16:18:05"
   }
}

Создать (Дополнительные настройки)

Create a new short url including some additional settings such as a custom short url, password to access and an expiry date.

параметры:
имя: тип: Описание:
key условие Ваш ключ доступа к API Вход для просмотра.
url условие Base64 кодируется версия длинной ссылки. base64_encode() в PHP.
custom_url (необязательный) условие Пользовательская короткая часть URL.
password (необязательный) условие Пароль для доступа к URL.
expiry_date (необязательный) условие Дата истечения срока действия URL-адреса. В формате yyyy-mm-dd.
base_domain (необязательный) условие URL, чтобы использовать для короткого URL. Должен уже существовать на сайте. Никакой http или запаздывающая наклонная черта вправо. т.е. domain.com
Return Values:
имя: тип: Описание:
url_id целое Уникальный идентификатор URL.
short_url условие Короткий URL, включая доменное имя.
short_url_part условие Короткая часть url. (Исключая доменное имя)
original_url условие Оригинальный декодированный длинный URL-адрес.
date_time условие Дата и время вызова API. В формате yyyy-mm-dd hh:mm:ss.
Пример запроса:
API адрес: https://url3.ru
GET //api/v1/8faf3b3e66440013eb1e543ae95763ca/shorturl/create/custom_url/CUSTOM_SHORT_URL/password/PASSWORD_TO_ACCESS/expiry_date/URL_EXPIRY_DATE/url/BASE64_ENCODED_LONG_URL.json
Пример ответа:
{
   "code":200,
   "data":{
      "url_id":"1388598",
      "short_url":"https://url3.ru/bbc",
      "short_url_part":"bbc",
      "original_url":"http://www.bbc.co.uk",
      "date_time":"2013-04-04 16:18:08"
   }
}

запрещено

Disable an active short url within your account.

параметры:
имя: тип: Описание:
key условие Ваш ключ доступа к API Вход для просмотра.
short_url условие Base64 Закодированная версия вашего короткого URL-адреса. base64_encode() in PHP.
Return Values:
имя: тип: Описание:
url_id целое Уникальный идентификатор URL.
status условие Статус короткой ссылки
short_url условие Короткий URL, включая доменное имя.
date_time условие Дата и время вызова API. В формате yyyy-mm-dd hh:mm:ss.
Пример запроса:
API адрес: https://url3.ru
GET //api/v1/8faf3b3e66440013eb1e543ae95763ca/shorturl/disable/short_url/BASE64_ENCODED_SHORT_URL.json
Пример ответа:
{
   "code":200,
   "data":{
      "url_id":"1388598",
      "status":"disabled",
      "short_url":"https://url3.ru/bbc",
      "date_time":"2013-04-04 17:01:42"
   }
}

Запустить

Activate a disabled short url within your account.

параметры:
имя: тип: Описание:
key условие Ваш ключ доступа к API Вход для просмотра.
short_url условие Base64 Закодированная версия вашего короткого URL-адреса. base64_encode() in PHP.
Return Values:
имя: тип: Описание:
url_id целое Уникальный идентификатор URL.
status условие Статус короткой ссылки
short_url условие Короткий URL, включая доменное имя.
date_time условие Дата и время вызова API. В формате yyyy-mm-dd hh:mm:ss.
Пример запроса:
API адрес: https://url3.ru
GET //api/v1/8faf3b3e66440013eb1e543ae95763ca/shorturl/enable/short_url/BASE64_ENCODED_SHORT_URL.json
Пример ответа:
{
   "code":200,
   "data":{
      "url_id":"1388598",
      "status":"active",
      "short_url":"https://url3.ru/bbc",
      "date_time":"2013-04-04 17:01:42"
   }
}

Информация

Get detailed information for any short url within your account.

параметры:
имя: тип: Описание:
key условие Ваш ключ доступа к API Вход для просмотра.
short_url условие Base64 Закодированная версия вашего короткого URL-адреса. base64_encode() in PHP.
Return Values:
имя: тип: Описание:
url_id целое Уникальный идентификатор URL.
short_url условие Короткий URL, включая доменное имя.
short_url_part условие Короткая часть url. (Исключая доменное имя)
original_url условие Оригинальный декодированный длинный URL-адрес.
date_created условие Дата / время создания короткого URL.
last_accessed условие Дата / время последнего обращения к url.
total_visits целое Все посещения
has_password bool Требуется ли URL для доступа к паролю.
expiry_date условие Дата / время истечения срока действия короткого URL.
status условие Статус короткой ссылки
date_time условие Дата и время вызова API. В формате yyyy-mm-dd hh:mm:ss.
Пример запроса:
API адрес: https://url3.ru
GET //api/v1/8faf3b3e66440013eb1e543ae95763ca/shorturl/info/short_url/BASE64_ENCODED_SHORT_URL.json
Пример ответа:
{
   "code":200,
   "data":{
      "url_id":"13423436",
      "short_url":"https://url3.ru/bbc",
      "short_url_part":"bbc",
      "original_url":"http://www.bbc.co.uk",
      "date_created":"2013-04-04 12:36:09",
      "last_accessed":"2013-05-02 12:32:05",
      "total_visits":"3452",
      "has_password":true,
      "expiry_date":"2019-03-02 23:59:59",
      "status":"active",
      "date_time":"2013-04-04 17:10:14"
   }
}

Список

List all active urls within your account.

параметры:
имя: тип: Описание:
key условие Ваш ключ доступа к API Вход для просмотра.
Return Values:
имя: тип: Описание:
urls array Список коротких URL-адресов в аккаунте.
date_time условие Дата и время вызова API. В формате yyyy-mm-dd hh:mm:ss.
Пример запроса:
API адрес: https://url3.ru
GET //api/v1/8faf3b3e66440013eb1e543ae95763ca/shorturl/list_active_urls.json
Пример ответа:
{
   "code":200,
   "data":{
      "urls":[
         {
            "short_url":"https://url3.ru/2F"
         },
         {
            "short_url":"https://url3.ru/2q"
         }
      ],
      "date_time":"2013-04-09 09:48:05"
   }
}
Копирайт © 2024 - Url3.ru . Url3.ru - Сокращаем ссылки на ура
Яндекс.Метрика
English (en)Русский