B-1.SU API

Обзор

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

Примеры ниже генерируют ответы в json, но вы также можете использовать xml, заменив конец вызова url-адреса .XML.


Создать

Создайте новый короткий url, предоставляющий версию исходного длинного url в кодировке base64.

Параметры:
Имя: Тип: Описание:
key Строка Ваш ключ доступа к API. Войдите, чтобы посмотреть.
url Строка Base64 encoded version of your long url. base64_encode() in PHP.
Значение:
Имя: Тип: Описание:
url_id Целое число Уникальный идентификатор url.
short_url Строка Короткий url, включая доменное имя.
short_url_part Строка Короткий URL-адрес. (исключая доменное имя)
original_url Строка Исходный декодированный длинный url.
date_time Строка Date and time of the API call. In the format yyyy-mm-dd hh:mm:ss.
Пример запроса:
Адрес API: http://b-1.su
GET //api/v1/3b9359e789418f9db956bac24b8efe14/shorturl/create/url/BASE64_ENCODED_LONG_URL.json
Пример ответа:
{
   "code":200,
   "data":{
      "url_id":"1388597",
      "short_url":"http://b-1.su/srt",
      "short_url_part":"srt",
      "original_url":"http://www.bbc.co.uk",
      "date_time":"2013-04-04 16:18:05"
   }
}

Создать (Дополнительные Параметры)

Создайте новый короткий url, включая некоторые дополнительные параметры, такие как пользовательский короткий url, пароль для доступа и срок действия.

Параметры:
Имя: Тип: Описание:
key Строка Ваш ключ доступа к API. Войдите, чтобы посмотреть.
url Строка Base64 encoded version of your long url. base64_encode() in PHP.
custom_url (Необязательный) Строка Пользовательская короткая часть url.
password (Необязательный) Строка Пароль для доступа к URL.
expiry_date (Необязательный) Строка Дата истечения срока действия url-адреса. В формате yyyy-mm-dd
base_domain (Необязательный) Строка Url to use for the short url. Must already exist on the site. No http or trailing forward slash. i.e. domain.com
Значение:
Имя: Тип: Описание:
url_id Целое число Уникальный идентификатор url.
short_url Строка Короткий url, включая доменное имя.
short_url_part Строка Короткий URL-адрес. (исключая доменное имя)
original_url Строка Исходный декодированный длинный url.
date_time Строка Date and time of the API call. In the format yyyy-mm-dd hh:mm:ss.
Пример запроса:
Адрес API: http://b-1.su
GET //api/v1/3b9359e789418f9db956bac24b8efe14/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://b-1.su/bbc",
      "short_url_part":"bbc",
      "original_url":"http://www.bbc.co.uk",
      "date_time":"2013-04-04 16:18:08"
   }
}

отключить

Отключите активный короткий url в вашей учетной записи.

Параметры:
Имя: Тип: Описание:
key Строка Ваш ключ доступа к API. Войдите, чтобы посмотреть.
short_url Строка Base64 encoded version of your short url. base64_encode() in PHP.
Значение:
Имя: Тип: Описание:
url_id Целое число Уникальный идентификатор url.
status Строка Короткое статуса URL-адреса.
short_url Строка Короткий url, включая доменное имя.
date_time Строка Date and time of the API call. In the format yyyy-mm-dd hh:mm:ss.
Пример запроса:
Адрес API: http://b-1.su
GET //api/v1/3b9359e789418f9db956bac24b8efe14/shorturl/disable/short_url/BASE64_ENCODED_SHORT_URL.json
Пример ответа:
{
   "code":200,
   "data":{
      "url_id":"1388598",
      "status":"disabled",
      "short_url":"http://b-1.su/bbc",
      "date_time":"2013-04-04 17:01:42"
   }
}

Активировать

Активируйте отключенный короткий url-адрес в своей учетной записи.

Параметры:
Имя: Тип: Описание:
key Строка Ваш ключ доступа к API. Войдите, чтобы посмотреть.
short_url Строка Base64 encoded version of your short url. base64_encode() in PHP.
Значение:
Имя: Тип: Описание:
url_id Целое число Уникальный идентификатор url.
status Строка Короткое статуса URL-адреса.
short_url Строка Короткий url, включая доменное имя.
date_time Строка Date and time of the API call. In the format yyyy-mm-dd hh:mm:ss.
Пример запроса:
Адрес API: http://b-1.su
GET //api/v1/3b9359e789418f9db956bac24b8efe14/shorturl/enable/short_url/BASE64_ENCODED_SHORT_URL.json
Пример ответа:
{
   "code":200,
   "data":{
      "url_id":"1388598",
      "status":"active",
      "short_url":"http://b-1.su/bbc",
      "date_time":"2013-04-04 17:01:42"
   }
}

Инфо

Получите подробную информацию о любом коротком url-адресе в вашей учетной записи.

Параметры:
Имя: Тип: Описание:
key Строка Ваш ключ доступа к API. Войдите, чтобы посмотреть.
short_url Строка Base64 encoded version of your short url. base64_encode() in PHP.
Значение:
Имя: Тип: Описание:
url_id Целое число Уникальный идентификатор url.
short_url Строка Короткий url, включая доменное имя.
short_url_part Строка Короткий URL-адрес. (исключая доменное имя)
original_url Строка Исходный декодированный длинный url.
date_created Строка The date/time the short url was create.
last_accessed Строка The date/time the short url was last accessed.
total_visits Целое число Общее число посещений
has_password bool Нужен ли url-адрес для доступа к паролю.
expiry_date Строка The date/time the short url will expire.
status Строка Короткое статуса URL-адреса.
date_time Строка Date and time of the API call. In the format yyyy-mm-dd hh:mm:ss.
Пример запроса:
Адрес API: http://b-1.su
GET //api/v1/3b9359e789418f9db956bac24b8efe14/shorturl/info/short_url/BASE64_ENCODED_SHORT_URL.json
Пример ответа:
{
   "code":200,
   "data":{
      "url_id":"13423436",
      "short_url":"http://b-1.su/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"
   }
}

Список

Список всех активных URL-адресов в вашей учетной записи.

Параметры:
Имя: Тип: Описание:
key Строка Ваш ключ доступа к API. Войдите, чтобы посмотреть.
Значение:
Имя: Тип: Описание:
urls массив Список коротких URL-адресов внутри учетной записи.
date_time Строка Date and time of the API call. In the format yyyy-mm-dd hh:mm:ss.
Пример запроса:
Адрес API: http://b-1.su
GET //api/v1/3b9359e789418f9db956bac24b8efe14/shorturl/list_active_urls.json
Пример ответа:
{
   "code":200,
   "data":{
      "urls":[
         {
            "short_url":"http://b-1.su/2F"
         },
         {
            "short_url":"http://b-1.su/2q"
         }
      ],
      "date_time":"2013-04-09 09:48:05"
   }
}