Desenvolvedor API

Guia de API Abreai.net

Aqui vamos explicar como usar a nova API do Abreai.net. Houve algumas mudanças na API, a fim facilitar os pedidos de desenvolvedores.

Registrando para uma chave de API

Como antes, uma chave de API é necessária para os pedidos serem processados pelo sistema. Uma vez que um usuário se registra, uma chave de API é gerado automaticamente para esse usuário. A chave API deve estar em anexo para solicitação via parâmetro da api (veja o exemplo completo abaixo).

Enviar um pedido para encurtar uma URL

Para enviar uma solicitação, o usuário deve usar o seguinte formato, onde as variáveis api e url são obrigatórios. No exemplo abaixo, o URL da demo é usado. Para solicitar um nome personalizado, basta adicionar &custom= no final.

 

Para gerar nome personalizado com a URL

  GET http://abreai.net/api?api=APIKEY&url=http://urldeexemplo.com.br&custom=NOMECUSTUMIZADO

Gerando nome url automático

GET http://abreai.net/api?api=APIKEY&url=http://urldeexemplo.com.br

 

Resposta do servidor

Como antes, a resposta será codificado no formato JSON (padrão). Isto é feito para facilitar o uso de linguagens. O primeiro elemento da resposta será sempre dizer se ocorreu um erro (erro: 1) ou não (erro: 0). O segundo elemento mudará em relação ao primeiro elemento. Se houver um erro, o segundo elemento será nomeado "msg". que contém a fonte de erro, caso contrário ele será chamado "short", que contém a URL curta. (Veja abaixo um exemplo)

// Sem Erros
{
  "error":0,
  "short":"http:\/\/abreai.nett\/DkZOb"
}
// Ocorreu erro
{
  "error":1,
  "msg":"Please enter a valid email"
}

 

Usando formato de texto simples

Agora você pode solicitar que a resposta seja em texto simples apenas adicionando & format = text no final do seu pedido. Isso irá retornar apenas http://abreai.net/DkZOb em vez da resposta JSON. Observe que, se ocorrer um erro, ele será qualquer coisa de saída.

Exemplo com format

GET http://abreai.net/api?api=APIKEY&url=http://urldeexemplo.com.br&custom=NOMECUSTUMIZADO&format=text

 

Utilizando a API em PHP

Para usar a API na sua aplicação PHP, você tem que enviar um pedido GET através file_get_contents ou cURL : Ambos são métodos confiáveis.Você pode ver um código de exemplo abaixo usando file_get_contents .

  // Usando Resposta JSON
  $api_url="http://abreai.net/api?api=APIKEY&url=http://urldeexemplo.com.br&custom=CUSTOMALIAS";
  $res= @json_decode(file_get_contents($api_url),TRUE);
  if($res["error"]){
    echo $res["msg"];
  }else{
    echo $res["short"];
  }
  // Usando Resposta Text
  $api_url="http://abreai.net/api?api=APIKEY&url=http://urldeexemplo.com.br&custom=CUSTOMALIAS&format=text";
  $res= @file_get_contents($api_url);
  if($res){
    echo $res;
  }
?>