Прикладной интерфейс (API)
Метод shot
С помощью POST запроса на метод (https://1-url.ru/api/dev/v1/shot), можно сократить ссылку.
Обязательные параметры:
- — key - Ваш api ключ. Можно получить в личном кабинете.
- — longurl - Ссылка, которую нужно сократить.
Дополнительные параметры:
- — alias - Имя хеша для ссылки. Например: https://1-co.ru/yyyyy. yyyyy - это alias.
- — pass - Пароль для перехода по ссылке.
- — data_start - Время в Unix, когда ссылка заработает.
- — data_end - Время в Unix, когда ссылка прекратит работу.
Возвращаемые параметры (при успешном сокращении):
- — response - Ответ сервера.
- — alias - Хеш ссылки.
- — fulllink - Полная ссылка вида "https://1-co.ru/yyyyy".
- — urlgo - Оригинал ссылки.
- — time - Время сокращения ссылки в Unix.
- — ip - Ip того, кто сократил ссылку.
- — id_own - Id владельца ссылки в системе.
- — pass - Ваш пароль на ссылку в md5.
Возвращаемые параметры (при ошибке):
- — response - Ответ сервера.
Коды response:
- — 100 - Проблема с api ключом.
- — 101 - Отсутствует longurl.
- — 102 - Проблема с url.
- — 103 - Alias существует в базе.
- — 104 - Alias должен состоять из (A-Za-z0-9_-).
- — 105 - Alias должен быть длиннее 4, но короче 20 символов.
- — 106 - Проблема с data_start.
- — 107 - Проблема с data_end.
- — 108 - Конфликт прошлого и будущего.
- — 200 - OK
Пример вызова API на PHP:
$url = 'https://1-url.ru/api/dev/v1/shot';
$params = array(
'key' => '13MEJTsUu6ryI1TFRsR6Td49rSJMXfLuXB2zh4cOTCkk6deEEBE0obrk0IM9J356', //ключ
'longurl' => 'https://example.ru',
'alias' => 'xxxxxx',
'data_start' => 1643581700,
);
$result = file_get_contents($url, false, stream_context_create(array(
'http' => array(
'method' => 'POST',
'header' => 'Content-type: application/x-www-form-urlencoded',
'content' => http_build_query($params)
)
)));
echo $result;