Сервис коротких ссылок API

Использование API

API позволяет Вам использовать возможность сокращения ссылок на любом сайте. После регистрации на сайте Вам доступен API ключ, который будет использован для вызовов методов API.

В приведенных примерах используется формат данных json. Также можно использовать формат данных xml, для этого нужно в запросе заменить .json на .xml.


Создание ссылки

Метод для создания новой ссылки.

Параметры:
Название: Тип: Описание:
key string Ваш API ключ. Login to view.
url string Оригинальная ссылка, закодированная функцией base64. base64_encode() в PHP.
Ответ сервера:
Название: Тип: Описание:
url_id integer Id ссылки.
short_url string Короткая ссылка, включая имя домена.
short_url_part string Короткая ссылка без название домена.
original_url string Оригинальная ссылка.
date_time string Дата и время вызова API. В формате yyyy-mm-dd hh:mm:ss.
Пример запроса:
API Address: https://h4l.ru
GET //api/v1/480aa077f3435e6b76023cd1d17c0352/shorturl/create/url/BASE64_ENCODED_LONG_URL.json
Пример ответа:
{
   "code":200,
   "data":{
      "url_id":"1388597",
      "short_url":"https://h4l.ru/srt",
      "short_url_part":"srt",
      "original_url":"http://www.bbc.co.uk",
      "date_time":"2013-04-04 16:18:05"
   }
}

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

Создание короткой ссылки с дополнительными настройками такими, как префикс, пароль, дата до которой работает ссылка.

Параметры:
Название: Тип: Описание:
key string Ваш API ключ. Login to view.
url string Оригинальная ссылка, закодированная функцией base64. base64_encode() в PHP.
custom_url (optional) string Префикс для короткой ссылки.
password (optional) string Пароль для доступа к ссылке.
expiry_date (optional) string Дата до которой действительна ссылка. В формате yyyy-mm-dd.
base_domain (optional) string Домен для сокращения ссылок.
Ответ сервера:
Название: Тип: Описание:
url_id integer Id ссылки.
short_url string Короткая ссылка, включая имя домена.
short_url_part string Короткая ссылка без название домена.
original_url string Оригинальная ссылка.
date_time string Дата и время вызова API. В формате yyyy-mm-dd hh:mm:ss.
Пример запроса:
API Address: https://h4l.ru
GET //api/v1/480aa077f3435e6b76023cd1d17c0352/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://h4l.ru/bbc",
      "short_url_part":"bbc",
      "original_url":"http://www.bbc.co.uk",
      "date_time":"2013-04-04 16:18:08"
   }
}

Отключение ссылки

Отключить короткую ссылку.

Параметры:
Название: Тип: Описание:
key string Ваш API ключ. Login to view.
short_url string Короткая ссылка, закодированная функцией base64. base64_encode() в PHP.
Ответ сервера:
Название: Тип: Описание:
url_id integer Id ссылки.
status string Статус ссылки.
short_url string Короткая ссылка, включая имя домена.
date_time string Дата и время вызова API. В формате yyyy-mm-dd hh:mm:ss.
Пример запроса:
API Address: https://h4l.ru
GET //api/v1/480aa077f3435e6b76023cd1d17c0352/shorturl/disable/short_url/BASE64_ENCODED_SHORT_URL.json
Пример ответа:
{
   "code":200,
   "data":{
      "url_id":"1388598",
      "status":"disabled",
      "short_url":"https://h4l.ru/bbc",
      "date_time":"2013-04-04 17:01:42"
   }
}

Активация

Включить короткую ссылку.

Параметры:
Название: Тип: Описание:
key string Ваш API ключ. Login to view.
short_url string Короткая ссылка, закодированная функцией base64. base64_encode() в PHP.
Ответ сервера:
Название: Тип: Описание:
url_id integer Id ссылки.
status string Статус ссылки.
short_url string Короткая ссылка, включая имя домена.
date_time string Дата и время вызова API. В формате yyyy-mm-dd hh:mm:ss.
Пример запроса:
API Address: https://h4l.ru
GET //api/v1/480aa077f3435e6b76023cd1d17c0352/shorturl/enable/short_url/BASE64_ENCODED_SHORT_URL.json
Пример ответа:
{
   "code":200,
   "data":{
      "url_id":"1388598",
      "status":"active",
      "short_url":"https://h4l.ru/bbc",
      "date_time":"2013-04-04 17:01:42"
   }
}

Информация

Получить информацию о ссылке.

Параметры:
Название: Тип: Описание:
key string Ваш API ключ. Login to view.
short_url string Короткая ссылка, закодированная функцией base64. base64_encode() в PHP.
Ответ сервера:
Название: Тип: Описание:
url_id integer Id ссылки.
short_url string Короткая ссылка, включая имя домена.
short_url_part string Короткая ссылка без название домена.
original_url string Оригинальная ссылка.
date_created string Время создания ссылки.
last_accessed string Время последнего перехода по ссылке.
total_visits integer Всего переходов
has_password bool Нужен ли пароль для ссылки.
expiry_date string Дата до которой ссылка будет работать.
status string Статус ссылки.
date_time string Дата и время вызова API. В формате yyyy-mm-dd hh:mm:ss.
Пример запроса:
API Address: https://h4l.ru
GET //api/v1/480aa077f3435e6b76023cd1d17c0352/shorturl/info/short_url/BASE64_ENCODED_SHORT_URL.json
Пример ответа:
{
   "code":200,
   "data":{
      "url_id":"13423436",
      "short_url":"https://h4l.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"
   }
}

Список ссылок

Получить список всех активных ссылок.

Параметры:
Название: Тип: Описание:
key string Ваш API ключ. Login to view.
Ответ сервера:
Название: Тип: Описание:
urls array Список Ваших коротких ссылок.
date_time string Дата и время вызова API. В формате yyyy-mm-dd hh:mm:ss.
Пример запроса:
API Address: https://h4l.ru
GET //api/v1/480aa077f3435e6b76023cd1d17c0352/shorturl/list_active_urls.json
Пример ответа:
{
   "code":200,
   "data":{
      "urls":[
         {
            "short_url":"https://h4l.ru/2F"
         },
         {
            "short_url":"https://h4l.ru/2q"
         }
      ],
      "date_time":"2013-04-09 09:48:05"
   }
}