API

Для разработчиков

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

 

Регистрация для API Key

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

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

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

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

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

Как и прежде, ответ будет закодирован в формате JSON (по умолчанию). Это сделано, чтобы облегчить использование кросс- языка. Первый элемент ответа будет всегда говорить, если произошла ошибка (ошибка : 1) или нет (ошибка : 0 ). Второй элемент изменится относительно первого элемента. Если есть ошибка, то второй элемент будет назван " MSG" . который содержит источник ошибок, в противном случае это будет называться "короткий", который содержит сокращённый URL (вашу сокращённую ссылку).
(Смотрите ниже примера ответа)

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

Использование простого текстового формата

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

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

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

-php-
  // Using JSON Response
  $api_url="http://5url.ru/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://5url.ru/api?api=APIKEY&url=THELONGURLTOBESHORTENED&custom=CUSTOMALIAS&format=text";
  $res= @file_get_contents($api_url);
  if($res){
    echo $res;
  }
-php-

 

=======================================================================================


Defelopers

Here I will explain how to use the new API. There were some changes to the API in order facilitate requests from developers.

Registering for an API Key

As before, an API key is required for requests to be processed by the system. Once a user registers, an API key is automatically generated for this user. The API key must attached to request via the api parameter (see full example below).

Sending a request for shortening a URL

To send a request, the user must use the following format where the variables api and url are required. In the example below, the URL of the demo is used but you should use your own domain name. To request a custom alias, simply add &custom= at the end.

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

Server response

As before, the response will encoded in JSON format (default). This is done to facilitate cross-language usage. The first element of the response will always tell if an error has occurred (error: 1) or not (error: 0). The second element will change with respect to the first element. If there is an error, the second element will be named “msg”. which contains the source of error, otherwise it will be named “short” which contains the short URL. (See below for an example)

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

Using plain text format

You can now request the response to be in plain text by just adding &format=text at the end of your request. This will return just http://5url.ru/DkZOb instead of the JSON response. Note that if an error occurs, it will not output anything.

Using the API in PHP

To use the API in your PHP application, you have to send a GET request through file_get_contents or cURL: Both are reliable methods. You can see a sample code below using file_get_contents.

-php-
  // Using JSON Response
  $api_url="http://5url.ru/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://5url.ru/api?api=APIKEY&url=THELONGURLTOBESHORTENED&custom=CUSTOMALIAS&format=text";
  $res= @file_get_contents($api_url);
  if($res){
    echo $res;
  }
-php-