API документация

Введение

API документация для пользователей li2s.ru, дающая разъяснения и инструкции по получению коротких ссылок от нашего сервиса, используя запросы к шлюзу API.

Запросы

Чтобы получить короткую ссылку, используя наш сервис из вне. Вам нужно воспользоваться cUrl для отправки запроса, передав следуюшие POST парметры

Так же наш сервис может выдать уже отформатирванный ответ. Для этого нужно передать в запрос параметр format. Для указания места, где будет находится короткая ссылка, добавьте в сообщение %link%.

  • url - Адрес, который нужно укоротить
  • format - Содержание контета для выдачи уже в отформатированном виде

В ответ наш сервис выдаст информацию в JSON формате, содержающую один из ключей:

  • link - Сформированную ссылку
  • message - Текст сообщения, если был передан параметр format
  • error - Код ошибки, в случае если ссылка не была сформирована

Примеры

Пример запроса выглядит так: https://li2s.ru /api/?url=https://yandex.ru/search/?text=%D1%84%D1%84%D1%8B%D0%B2&lr=197&clid=2186621

Если вам нужен сформированый контект можете передать параметр format. Запрос будет выглядеть так: https://li2s.ru /api/?url=http://test.ru/aisdbkai.html&format=<div>%link%</div>

Инструменты для работы

Для удобства использования сервиса мы собрали класс работы с нашим сервисом позволяющий удобно работать используя только методы для минификации кода

Данный класс доступен на GitHub

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

stringurl

По умолчанию: none
C помощью данного свойства вы передаете на сервер ваш входной адресс, требующий преобразований

stringformat

По умолчанию: none
В этом параметре вы устанавливаете нужный HTML для ответа, в который передаете ключ для замены на короткую ссылку

stringjsonDecode

По умолчанию: none
свойство для работы с ответом, устанаилваиет потребность преобразования ответав JSON формат

stringjsonDecode

По умолчанию: none
свойство для работы с ответом, устанаилваиет потребность преобразования ответав JSON формат

stringjsonAsArray

По умолчанию: none
свойство для преобразования форматирования, устанавливает в аком виде будет выдан ответ в виде массива - true или в виде объекта - false. Подробнее здесь

stringencoded

По умолчанию: false
Свойство устанавливющее потребность в кодировании

stringcharset

По умолчанию: null
Свойство обязательное от encoded устанавливающее кодировку получаемых данных.