SOKru API

Сервис сокращателя ссылок SOKru
Документация API

Введение

Для использования API требуется отправить GET-запрос на API, соответствующему Вашему требованию.

Синтаксис запроса

Чтобы обратиться к API SOKru, требуется выполнить GET-запрос такого вида:

https://api.sokru.ru/METHOD

METHOD - метод API

Создание ссылки #наверх

Для создания ссылки можно выполнить запрос links.create, используя поле url. В ответ вы получите ответ, содержащий поля: short_url, key

Пример использования запроса:

https://api.sokru.ru/links.create?url=https://google.com

В ответ вы получите JSON-строку, как в примере ниже.

{
	"response": {
		"short_url":"https://qdk.pw/FjeLf",
		"key":"FjeLf"
	}
}

Получение статистики #наверх

Для получения статистики можно выполнить запрос links.stats, используя поле key. В ответ вы получите ответ, содержащий поля: key, uses_count

Пример использования запроса:

https://api.sokru.ru/links.stats?key=clO5m

В ответ вы получите JSON-строку, как в примере ниже.

{
	"response": {
		"key":"clO5m",
		"uses_count":31
	}
}

Получение полной ссылки #наверх

Для получения полной ссылки можно выполнить запрос links.getFull, используя поле key. В ответ вы получите ответ, содержащий поля: key, full_link

Пример использования запроса:

https://api.sokru.ru/links.getFull?key=clO5m

В ответ вы получите JSON-строку, как в примере ниже.

{
	"response": {
		"key":"clO5m",
		"full_link":"https://google.com"
	}
}

Пожаловаться #наверх

Для отправки ссылки модераторам для проверки на вирусы можно выполнить запрос links.report, используя поле url.

Пример использования запроса:

https://api.sokru.ru/links.report?url=https://qdk.pw/virus

Премиум-ссылки #наверх

Премиум-ссылки - ссылки с произвольным KEY, недоступные для обычного использования. Такие ссылки могут создавать только пользователи, подтвердившие свои намерения у администратора. Такие ссылки можно создать через администратора, либо используя API.

В отличие от стандартных ссылок, где KEY - 5-ти символьный автоматически-генерируемый код, KEY в премиум-ссылках определяется самим пользователем. Единственное ограничение - KEY должен быть длиной 6 или более символов.

Premium-links API

Для получения короткой премиум-ссылки можно выполнить запрос premium.create, используя поля key, url, accessToken. В ответ вы получите ответ, содержащий поля: key, short_link

Пример использования запроса:

https://api.sokru.ru/premium.create?key=EXAMPLEKEY&url=https://google.com&accessToken=EXAMPLETOKEN

В ответ вы получите JSON-строку, как в примере ниже.

{
	"response": {
		"key":"EXAMPLEKEY",
		"short_link":"https://qdk.pw/EXAMPLEKEY"
	}
}

Список ошибок #наверх

Ниже вы можете найти весь список ошибок.

[] изменяется на произвольное значение, в зависимости от скрипта

invalid_request
	- Key not exists - код короткой ссылки не существует
auth_error
	- Access token invalid - токен доступа недействителен
premium_error
	- Key already exists - ключ короткой ссылки уже существует в базе
	- Invalid length - длина ключа короткой ссылки меньше 6-ти символов