Пользователи могут сокращать длинные URL-адреса через веб-интерфейс https://lst.to или посредством программной стороны веб-сайта — Lst.to API. С помощью API вы можете создавать собственные приложения, использующие протокол HTTP для управления короткими ссылками.

Для начала работы с API необходимо пройти процедуру аутентификации. Для этого введите свой email в поле ниже — на него мы отправим аутентификационный токен.


После авторизации вы можете перейти к действию, которое вы хотите выполнить. У каждого действия есть краткое описание и пример использования. Все примеры используют протокол JSON в стиле REST.

Лимиты

По умолчанию каждый проект получает по 10 запросов в минуту.

Создать короткую ссылку

Lst.to API позволяет сократить длинный URL так же, как при использовании веб-версии сервиса. Отправьте следующий запрос:

POST https://lst.to/api/v1/link

Заголовки:

X-AUTH-TOKEN: JkdnskjmnsjOKSaPqd Content-Type: application/json

Пример тела запроса:

{ "data": { "type": "link", "url": "www.example.com", "utm": "utm_campaign=[domain]" } }
{ "data": { "type": "deeplink", "url": "www.example.com", "deeplink": { "ios":{ "deeplink_url": "app://www.example.com", "fallback_url": "itms-apps://www.example.com" } } } }
{ "data": { "type": "targeting", "url": "www.example.com", "targeting": { "ios": "www.example.com" } } }

Описание параметров запроса

JSON элемент Описание Тип
type Тип ссылки. Возможные варианты: link, deeplink, targeting Строка
url Конечный URL, куда по умолчанию будет перенаправлен пользователь Строка
utm Шаблон UTM-меток Строка
deeplink Объект, в котором содержатся диплинки. Внутри указывается устройство (возможные варианты: iOS или Android). Он должен содержать два свойства: deeplink (диплинк на приложение) и fallback — ссылку на установку приложения в App Store или Google Play Объект
targeting Объект с таргетингом по OS. Внутри указывается OS таргетируемого устройства (возможные варианты: iOS, Android и Other). Значение — это URL, куда будет перенаправлен пользователь Объект

Пример ответа:

{ "data": { "url": "https://www.example.com", "short": "https://lst.to/vhlck", "qr": "https://lst.to/vhlck.png", "type": "deeplink", "utm": "utm_campaign=[domain]", "created": "2018-12-04 09:58:39", "deeplink": { "ios": { "deeplink_url": "app://www.example.com", "fallback_url": "itms-apps://www.example.com" } } } }
JSON элемент Описание Тип
url Конечный URL, куда по умолчанию будет перенаправлен пользователь Строка
short Короткий URL Строка
qr URL картинки QR-кода Строка
type Тип ссылки. Возможные варианты: link, deeplink, targeting Строка
utm Шаблон UTM-меток Строка
created Дата и время создания Дата и время
deeplink Объект, в котором содержатся диплинки. Внутри указывается устройство (возможные варианты: iOS или Android). Он должен содержать два свойства: deeplink (диплинк на приложение) и fallback — ссылку на установку приложения в App Store или Google Play Объект
targeting Объект с таргетингом по OS. Внутри указывается OS таргетируемого устройства (возможные варианты: iOS, Android и Other). Значение — это URL, куда будет перенаправлен пользователь Объект

Обновить ссылку

С помощью Lst.to API можно отредактировать целевой URL короткой ссылки. Для этого отправьте следующий запрос:

PUT https://lst.to/api/v1/link/mvlck

Заголовки:

X-AUTH-TOKEN: JkdnskjmnsjOKSaPqd Content-Type: application/json

Пример тела запроса:

{ "data": { "type": "deeplink", "url": "www.example.com", "deeplink": { "ios":{ "deeplink_url": "app://www.example.com", "fallback_url": "itms-apps://www.example.com" } } } }

Удалить ссылку

Чтобы удалить короткую ссылку, отправьте запрос:

DELETE https://lst.to/api/v1/link/mvlck

Заголовки:

X-AUTH-TOKEN: JkdnskjmnsjOKSaPqd Content-Type: application/json

Получить ссылку

GET https://lst.to/api/v1/link/mvlck

Заголовки:

X-AUTH-TOKEN: JkdnskjmnsjOKSaPqd Content-Type: application/json

Пример ответа:

{ "data": { "url": "https://www.example.com", "short": "https://lst.to/vhlck", "qr": "https://lst.to/vhlck.png", "type": "deeplink", "utm": "utm_campaign=[domain]", "created": "2018-12-04 09:58:39", "deeplink": { "ios": { "deeplink_url": "app://www.example.com", "fallback_url": "itms-apps://www.example.com" } } } }

Получить все ссылки

Чтобы получить все ссылки, созданные с использованием вашего токена, отправьте запрос вида

GET https://lst.to/api/v1/link

Заголовки:

X-AUTH-TOKEN: JkdnskjmnsjOKSaPqd Content-Type: application/json

Пример ответа:

{ "data": { "url": "https://www.example.com", "short": "https://lst.to/vhlck", "qr": "https://lst.to/vhlck.png", "type": "deeplink", "utm": "utm_campaign=[domain]", "created": "2018-12-04 09:58:39", "deeplink": { "ios": { "deeplink_url": "app://www.example.com", "fallback_url": "itms-apps://www.example.com" } } } }, { "data": { "url": "https://www.example.com", "short": "https://lst.to/vhlck", "qr": "https://lst.to/vhlck.png", "type": "deeplink", "utm": "utm_campaign=[domain]", "created": "2018-12-04 09:58:39", "deeplink": { "ios": { "deeplink_url": "app://www.example.com", "fallback_url": "itms-apps://www.example.com" } } } }