Обзор
Наш интерфейс API позволяет создать короткую ссылку к любой нужной вам странице в Сети Интернет или для любого вашего веб-сайта. При регистрации новой ссылки для вашей учетной записи, ей генерируется уникальный ключ API, который будет использоваться в вызовах API, перечисленных ниже.
Приведенные ниже примеры генерируют отклики в формате JSON, но вы также можете использовать XML, заменив окончание ссылки запроса на .xml
Создать
Создайте короткую URL с 64-битной кодировкой оригинальной длинной ссылки.
Параметры:
название: |
тип: |
Описание: |
key |
строка |
Ваш ключ доступа к API. Авторизуйтесь, чтобы просмотреть. |
url |
строка |
Кодировка версии вашей длинной ссылки. base64_encode() in PHP. |
Возвращаемые значения:
название: |
тип: |
Описание: |
url_id |
целое |
Уникальный ID ссылки |
short_url |
строка |
короткая ссылка включающая имя домена |
short_url_part |
строка |
часть короткой ссылки. (без доменного имени) |
original_url |
строка |
Исходная декодируемая длинная ссылка. |
date_time |
строка |
Дата и время вызова API. В формате ГГГГ-ММ-ДД ЧЧ: мм: сс. |
Пример Запроса:
код API: http://u-2u.ru
GET //api/v1/67e334360dc47d6fea63efea7d450f5d/shorturl/create/url/BASE64_ENCODED_LONG_URL.json
Пример Ответа:
{
"code":200,
"data":{
"url_id":"1388597",
"short_url":"http://u-2u.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_encode() in PHP. |
custom_url (необязательный) |
строка |
Пользовательские короткие ссылки - часть. |
password (необязательный) |
строка |
Пароль для доступа к ссылкам |
expiry_date (необязательный) |
строка |
Дата прекращения работы ссылки в формате "год (хххх) - месяц (хх) - день (хх)" |
base_domain (необязательный) |
строка |
Ссылка для укорачивания. Должна быть на сайте. Без http:// не сокращать -. т.е. domain.com |
Возвращаемые значения:
название: |
тип: |
Описание: |
url_id |
целое |
Уникальный ID ссылки |
short_url |
строка |
короткая ссылка включающая имя домена |
short_url_part |
строка |
часть короткой ссылки. (без доменного имени) |
original_url |
строка |
Исходная декодируемая длинная ссылка. |
date_time |
строка |
Дата и время вызова API. В формате ГГГГ-ММ-ДД ЧЧ: мм: сс. |
Пример Запроса:
код API: http://u-2u.ru
GET //api/v1/67e334360dc47d6fea63efea7d450f5d/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":"http://u-2u.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 |
строка |
64-битная кодировка вашего укороченного URL. base64_encode() in PHP. |
Возвращаемые значения:
название: |
тип: |
Описание: |
url_id |
целое |
Уникальный ID ссылки |
status |
строка |
статус короткой ссылки |
short_url |
строка |
короткая ссылка включающая имя домена |
date_time |
строка |
Дата и время вызова API. В формате ГГГГ-ММ-ДД ЧЧ: мм: сс. |
Пример Запроса:
код API: http://u-2u.ru
GET //api/v1/67e334360dc47d6fea63efea7d450f5d/shorturl/disable/short_url/BASE64_ENCODED_SHORT_URL.json
Пример Ответа:
{
"code":200,
"data":{
"url_id":"1388598",
"status":"disabled",
"short_url":"http://u-2u.ru/bbc",
"date_time":"2013-04-04 17:01:42"
}
}
Активировать
Activate a disabled short url within your account.
Параметры:
название: |
тип: |
Описание: |
key |
строка |
Ваш ключ доступа к API. Авторизуйтесь, чтобы просмотреть. |
short_url |
строка |
64-битная кодировка вашего укороченного URL. base64_encode() in PHP. |
Возвращаемые значения:
название: |
тип: |
Описание: |
url_id |
целое |
Уникальный ID ссылки |
status |
строка |
статус короткой ссылки |
short_url |
строка |
короткая ссылка включающая имя домена |
date_time |
строка |
Дата и время вызова API. В формате ГГГГ-ММ-ДД ЧЧ: мм: сс. |
Пример Запроса:
код API: http://u-2u.ru
GET //api/v1/67e334360dc47d6fea63efea7d450f5d/shorturl/enable/short_url/BASE64_ENCODED_SHORT_URL.json
Пример Ответа:
{
"code":200,
"data":{
"url_id":"1388598",
"status":"active",
"short_url":"http://u-2u.ru/bbc",
"date_time":"2013-04-04 17:01:42"
}
}
сведения
Get detailed information for any short url within your account.
Параметры:
название: |
тип: |
Описание: |
key |
строка |
Ваш ключ доступа к API. Авторизуйтесь, чтобы просмотреть. |
short_url |
строка |
64-битная кодировка вашего укороченного URL. base64_encode() in PHP. |
Возвращаемые значения:
название: |
тип: |
Описание: |
url_id |
целое |
Уникальный ID ссылки |
short_url |
строка |
короткая ссылка включающая имя домена |
short_url_part |
строка |
часть короткой ссылки. (без доменного имени) |
original_url |
строка |
Исходная декодируемая длинная ссылка. |
date_created |
строка |
Дата / время создания короткой ссылки. |
last_accessed |
строка |
Дата / время последнего перехода по короткой ссылке |
total_visits |
целое |
Всего визитов |
has_password |
bool |
Нужен ли пароль для доступа к ссылкам |
expiry_date |
строка |
Дата / время истечения срока работы короткой ссылки |
status |
строка |
статус короткой ссылки |
date_time |
строка |
Дата и время вызова API. В формате ГГГГ-ММ-ДД ЧЧ: мм: сс. |
Пример Запроса:
код API: http://u-2u.ru
GET //api/v1/67e334360dc47d6fea63efea7d450f5d/shorturl/info/short_url/BASE64_ENCODED_SHORT_URL.json
Пример Ответа:
{
"code":200,
"data":{
"url_id":"13423436",
"short_url":"http://u-2u.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. Авторизуйтесь, чтобы просмотреть. |
Возвращаемые значения:
название: |
тип: |
Описание: |
urls |
выстроить |
Список укороченных URL-адресов вашей учетной записи. |
date_time |
строка |
Дата и время вызова API. В формате ГГГГ-ММ-ДД ЧЧ: мм: сс. |
Пример Запроса:
код API: http://u-2u.ru
GET //api/v1/67e334360dc47d6fea63efea7d450f5d/shorturl/list_active_urls.json
Пример Ответа:
{
"code":200,
"data":{
"urls":[
{
"short_url":"http://u-2u.ru/2F"
},
{
"short_url":"http://u-2u.ru/2q"
}
],
"date_time":"2013-04-09 09:48:05"
}
}