Сократить ссылку

Главная страница / О сервисе / Как пользоваться API

API! Мы говорим на русском и на API!

В двух словах: статистика и курощение* ссылок, не заходя на сайт. Статистика открыта для всех. А чтобы сокращать ссылки, мы должны быть с вами хоть немного знакомы. Разве много просим?

API — «Application Programming Interface», интерфейс, через который с Б23 могут работать любые внешние программы, которым нужен простой и надёжный сервис сокращения ссылок с дополнительными возможностями.

Все обращения, на которые мы отвечаем — простые GET-запросы. Например, для того, чтобы узнать, что в действительности находится за короткой ссылкой http://b23.ru/vgk, достаточно отправить запрос http://b23.ru/api/info/vgk, который выдаст исходную ссылку со всеми сведениями, которые у нас о ней есть.

Что можно делать с B23 через API?

B23 поддерживает три метода для работы с внешними сервисами:

  • /api/expand/[идентификатор ссылки] — получить исходную ссылку открытый метод
  • /api/info/[идентификатор ссылки] — статистика посещений и дополнительные сведения о ссылке открытый метод
  • /api/shorten/[полная ссылка] — cокращение ссылки закрытый метод

Ограничения

Так как API мы запускаем в качестве эксперимента, то пока ограничения стоят на уровне 30 запросов за 60 минут (начиная с момента первого запроса) для каждого ключа. Число анонимных запросов пока не ограничено ничем.

Методы

/api/expand — получение исходной ссылки

На входе принимает короткий идентификатор в виде GET-запроса.

Выдает исходную ссылку в виде plain text.

Доступ: открытый метод, общедоступен.

/api/info — статистика посещений и дополнительные сведения

На входе принимает короткий идентификатор в виде GET-запроса.

Результат выдаётся в XML-формате, со следующими полями:

  • short: идентификатор ссылки
  • long: ссылка полностью
  • title: заголовок, если он был получен роботом Б23
  • date: дата сокращения ссылки
  • clicks: число переходов по ссылке
  • spam: является или нет ссылка спамом
  • referers: список ссылающихся страниц, с которых пришли по ссылке
    • url: адрес ссылающейся страницы, с долей кликов, указанной в атрибуте percent

Доступ: открытый метод, статистика по ссылающимся страницам без авторизации ограничена доменами.

/api/shorten — сокращение длинных ссылок

На входе принимает полную ссылку, требующую сокращения, в следующем формате:

/api/shorten/ссылка?параметры%23якорь

Обратите внимание: знак якоря («хэш») должен передаваться в кодированном формате.

Выдаёт короткую ссылку в виде plain text.

Доступ: при обращении требует передать имя пользователя и API-ключ в качестве пароля в формате стандартной HTTP-авторизации.

Что такое API-ключ и для чего он нужен?

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

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


* — «Курощение» это не опечатка, АПИ действительно помогает курощать ссылки. Вот неплохая цитата из одного классического произведения:

А булочки всё же кто-то ел. Во всяком случае, они исчезали одна за другой, но лишь Малыш понимал, куда. Он тихо хихикал и даже осторожно отправил под стол стакан молока, чтобы Карлсону не уплетать булочки всухомятку.

Именно это Карлсон называл “курощение булочками”. Как это получается на практике, фрекен Бок уже успела узнать за прежние посещения Карлсона.

- Можно прекрасно курощать людей, поглощая все их булочки,  - заявил как-то Карлсон. Собственно, он знал, что нужно говорить «укрощать», но «курощать», уверял он, звучит куда более внушительно.

И теперь Карлсон устроил новое дьявольское «булочное курощение», хотя фрекен Бок этого и не поняла. И дядя Юлиус тоже. Он решительно не замечал «булочного курощения», несмотря на всю его дьявольскую силу, а только всё думал и думал о чём-то своём. Но вдруг он схватил руку фрекен Бок и крепко сжал, словно прося о помощи.

Ссылки, попадающие к нам, тоже не понимают, куда у них пропадают лишние знаки, и после курощения они становятся послушные, словно шёлковые.


Z23: Сокращаем без ТК