API
Документация API
API (Application Programming Interface) – набор готовых классов, процедур, функций, структур и констант, предоставляемых приложением (библиотекой, сервисом) для использования во внешних программных продуктах. Мы предоставляем API, для того чтобы другие приложения могли использовать наш сервис для сокращения ссылок. Вы можете получить доступ, представив HTTP GET запрос с соответствующими параметрами. И можете выбрать один из двух (xml, json) вариантов получения ответа.

Доступ к API

Для того чтобы воспользоваться API вам нужен API-ключ, а для этого вам необходимо зарегистрироваться.

  • Сократить
  • Редактировать
  • Список ссылок
  • Инфо о ссылке
  • Экспорт статистики
  • Удалить ссылки

Сокращение ссылки

Для того чтобы сократить ссылку необходимо передать нижеописанные параметры.

Параметр

Значение

Описание

* option create Параметр указывает скрипту, какое действие нужно выполнять.
* method xml, json Определяет вариант получения ответа.
* key Ваш API-ключ Позволяет работать с системой.
* link Сокращаемый url Указывается ссылка, которую нужно сократить.
link_name Ваше названье Позволяет ссылке присвоить любое свободное названье.
link_pass Пароль на ссылку Позволяет установить пароль на переход по короткой ссылке.
mail Ваш E-MAIL Нужен для: связи с вами, для уведомления о переходах и т.д.
send_stat 0 или 1 Если указан 1, то каждый раз после перехода вам придет уведомление с данными переходившего, а если указан 0, то данная функция отключается.
del_after -1 или любое целое число Позволяет указывать количество переходов после, которого ссылка автоматически удалится. Если указано -1, то ссыка никогда автоматически не удалится.

* — параметры обязательные для данного действия.

Пример запроса

XML



XML ответ

<link-info>
<short-link>
 http://s3s.so/jf39 
</short-link>
<private-key>
 EzG6 
</private-key>
<link>
 http://yandex.ru 
</link>
<link-name>
 jf39 
</link-name>
<link-pass>
 11 
</link-pass>
<mail>
 test@test.ru 
</mail>
<send-stat>
 1 
</send-stat>
<proz-link>
 джей эф тридцать девять 
</proz-link>
<qr-link>
 http://s3s.so/qr/jf39 
</qr-link>
</link-info>
1
JSON



JSON ответ

{
"short-link":"http:\/\/s3s.so\/hP42",
"private-key":"LTHw",
"link":"http:\/\/yandex.ru",
"link-name":"hP42",
"link-pass":"11",
"mail":"test@test.ru",
"send-stat":"1",
"proz-link":"\u044d\u0439\u0447 \u041f\u0418 \u0441\u043e\u0440\u043e\u043a \u0434\u0432\u0430",
"qr-link":"http:\/\/s3s.so\/qr\/hP42"
}

Редактирование ссылки

При редактировании значения передаваемых параметров заменяют существующие значения. Для редактирования ссылки нужно передать нижеописанные параметры.

Параметр

Значение

Описание

* option edit Параметр указывает скрипту, какое действие нужно выполнять.
* method xml, json Определяет вариант получения ответа.
* key Ваш API-ключ Позволяет работать с системой.
* private_key секретный ключ Указывается секретный ключ редактируемой ссылки, чтобы система поняла какую именно ссылку нужно редактировать.
link Новый url Старый адрес изменится на указанный
link_name Названье ссылки Старое названье изменится на указанное.
link_pass Пароль, del Позволяет установить, изменить пароль, который запрашивается при переходе по ссылке. Для удаления ранее установленного пароля нужно в качестве значения передавать "del".
mail E-MAIL, del Позволяет добавить, изменить ранее добавленный или удалить E-MAIL. Для удаления нужно в качестве значения передавать "del".
send_stat 0 или 1 Если указан 1, то каждый раз после перехода вам придет уведомление с данными переходившего, а если указан 0, то данная функция отключается.
del_after -1 или любое целое число Позволяет указывать количество переходов после, которого ссылка автоматически удалится. Если указано -1, то ссыка никогда автоматически не удалится.

* — параметры обязательные для данного действия.

Пример запроса

XML



XML ответ

<link-info>
<short-link>
 http://s3s.so/22 
</short-link>
<private-key>
 EzG6 
</private-key>
<link>
 http://google.ru 
</link>
<link-name>
 22 
</link-name>
<link-pass>
</link-pass>
<mail>
</mail>
<send-stat>
 0 
</send-stat>
<del-after>
 5 
</del-after>
</link-info>
1
JSON



JSON ответ

{
"short-link":"http:\/\/s3s.so\/22",
"private-key":"EzG6",
"link":"http:\/\/google.ru",
"link-name":"22",
"link-pass":"",
"mail":"",
"send-stat":"0",
"del-after":"5"
}

Просмотр списка сокращенных ссылок

Для просмотра списка сокращенных ссылок нужно передать нижеописанные параметры.

Параметр

Значение

Описание

* option view Параметр указывает скрипту, какое действие нужно выполнять.
* method xml, json Определяет вариант получения ответа.
* key Ваш API-ключ Позволяет работать с системой.

* — параметры обязательные для данного действия.

Пример запроса

XML



XML ответ

<links>
<link>
<date-shorted>
2014-05-16 16:07:03
</date-shorted>
<short-link>
http://s3s.so/test
</short-link>
<url>
http://yandex.ru
</url>
<private-key>
zcUT
</private-key>
<hits>
0
</hits>
</link>
1
JSON



JSON ответ

[
{
"date":"2014-05-16 16:07:03",
"link":"test",
"url":"http:\/\/yandex.ru",
"key":"zcUT",
"hits":"0"
}
]

Просмотр информации о конкретной ссылке

Для просмотра информации о конкретной короткой ссылке нужно передать нижеописанные параметры.

Параметр

Значение

Описание

* option view Параметр указывает скрипту, какое действие нужно выполнять.
* method xml, json Определяет вариант получения ответа.
* key Ваш API-ключ Позволяет работать с системой.
* private_key секретный ключ Нужно указывать секретный ключ, той ссылки информацию о которой необходимо получить.

* — параметры обязательные для данного действия.

Пример запроса

XML



XML ответ

<link-info>
<short-link>
 http://s3s.so/22 
</short-link>
<hits>
 0 
</hits>
<private-key>
 EzG6 
</private-key>
<link>
 http://google.ru 
</link>
<link-name>
 22 
</link-name>
<link-pass>
</link-pass>
<mail>
</mail>
<send-stat>
 0 
</send-stat>
<del-after>
 5 
</del-after>
<proz-link>
 двадцать два 
</proz-link>
<qr-link>
 http://s3s.so/qr/22 
</qr-link>
</link-info>
1
JSON



JSON ответ

{
"short-link":"http:\/\/s3s.so\/22",
"hits":"0",
"private-key":"EzG6",
"link":"http:\/\/google.ru",
"link-name":"22",
"link-pass":"",
"mail":"",
"send-stat":"0",
"del-after":"5",
"proz-link":" \u0434\u0432\u0430\u0434\u0446\u0430\u0442\u044c \u0434\u0432\u0430",
"qr-link":"http:\/\/s3s.so\/qr\/22"
}

Экспорт статистики определенной ссылки

Для экспорта статистики определенной ссылки нужно передать нижеописанные параметры.

Параметр

Значение

Описание

* option export Параметр указывает скрипту, какое действие нужно выполнять.
* method xml, json Определяет вариант получения ответа.
* key Ваш API-ключ Позволяет работать с системой.
* private_key секретный ключ Нужно указывать секретный ключ, той ссылки статистику которой хотите экспортировать.

* — параметры обязательные для данного действия.

Пример запроса

XML



XML ответ

<success>
http://s3s.so/api/export/ВашAPI-ключ/H154/statistics.csv
</success>
1
JSON



JSON ответ

{
"http:\/\/s3s.so\/api\/export\/ВашAPI-ключ\/H154\/statistics.csv"
}

Удаление определенной ссылки

Для удаления определенной ссылки нужно передать нижеописанные параметры.

Параметр

Значение

Описание

* option del Параметр указывает скрипту, какое действие нужно выполнять.
* method xml, json Определяет вариант получения ответа.
* key Ваш API-ключ Позволяет работать с системой.
* private_key секретный ключ Нужно указывать секретный ключ, той ссылки статистику которой хотите экспортировать.

* — параметры обязательные для данного действия.

Пример запроса

XML



XML ответ

<success>
Ссылка удалена
</success>
1
JSON



JSON ответ

{
"\u0421\u0441\u044b\u043b\u043a\u0430 \u0443\u0434\u0430\u043b\u0435\u043d\u0430"
}