Разработчикам

Регистрация для получения ключа API

Ключ API требуется для запросов, обрабатываемых системой. После того, как пользователь регистрируется, ключ API автоматически создается для этого пользователя.

Отправка запроса на сокращение URL

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

  GET http://zyyz.ru/short/api?api=APIKEY&url=THELONGURLTOBESHORTENED&custom=CUSTOMALIAS

Ответ сервера

Ответ будет закодирован в формате JSON (по умолчанию). Первый элемент ответа всегда покажет, если произошла ошибка (ошибка: 1) или нет (ошибка: 0). Второй элемент изменится относительно первого элемента. Если есть ошибка, второй элемент будет называться "msg", который содержит источник ошибки, в противном случае она будет называться “short", который содержит короткий URL. (cм. пример ниже)

// No errors
{
  "error":0,
  "short":"http:\/\/zyyz.ru\/short\/DkZOb"
}
// An error has occurred
{
  "error":1,
  "msg":"Please enter a valid email"
}

Используя формат обычного текста

Теперь вы можете запросить ответ , чтобы быть в виде обычного текста, просто добавив  &format=text   в конце вашего запроса. Это вернет только http://zyyz.ru/short/DkZOb вместо ответа JSON. Обратите внимание , что в случае возникновения ошибки, она не будет ничего выводить.

Использование API в PHP

Для использования API в вашем PHP приложении, вы должны отправить GET запрос пройти через file_get_contents или cURL: оба надежные методы. Вы можете увидеть пример кода ниже с помощью file_get_contents.

<?php
  // Using JSON Response
  $api_url="http://zyyz.ru/short/api?api=APIKEY&url=THELONGURLTOBESHORTENED&custom=CUSTOMALIAS";
  $res= @json_decode(file_get_contents($api_url),TRUE);
  if($res["error"]){
    echo $res["msg"];
  }else{
    echo $res["short"];
  }

  // Using Plain Text Response
  $api_url="http://zyyz.ru/short/api?api=APIKEY&url=THELONGURLTOBESHORTENED&custom=CUSTOMALIAS&format=text";
  $res= @file_get_contents($api_url);
  if($res){
    echo $res;
  }
?>