Damos continuidade a explicação sobre o Projeto Aelle, na primeira parte falamos da utilização do site, e agora, falamos um pouco de sua API.
Antes de mais nada, devo informar que este post não serve como uma documentação da API do Aelle, ela já está escrita aqui.
Antes de começarmos você deve ter uma chave para realizar as consultas em nossa API, você pode consegui-la clicando aqui. E é claro, ler a documentação da API para não realizar nenhuma requisição errada.
Para o exemplo em PHP irei utilizar uma chave fictícia:
1 | 625v39165efy8mpum9da |
Utilizando PHP + Snoopy para se conectar ao Aelle.
O Snoopy (que pode ser encontrado aqui) é uma classe legal (que eu gosto de usar) para fazer requisições HTTP em outros sites. Caso você não queira muita dificuldade, recomendo que a utilize.
Observe o código abaixo utilizando o Snoopy:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | include("snoopy.class.php"); //Inicializa a classe Snoopy $snoopy = new Snoopy; //Defino uma variável onde posso guardar a Chave da API //E também a URL de consulta $chaveAPI = "625v39165efy8mpum9da"; $urlConsulta = "http://api.projetoaelle.com/1/info/user/".$chaveAPI.":json"; //É interessante que você indique um User Agent //(que pode ser criado por você para identificar o seu sistema) e //um site de referência (que seja o seu). $snoopy->agent = "Foco Livre Exemplo (Teste do Blog; PT-BR) v1.0"; $snoopy->referer = "http://blog.focolivre.com/"; //Realizo a consulta na API do Projeto Aelle if($snoopy->fetchtext($urlConsulta)) { echo $snoopy->results; } else { echo "Ocorreu um erro: ".$snoopy->error; } |
Da maneira como foi mostrado acima, o sistema retornaria um texto em formato JSON, como mostrado abaixo:
1 2 3 4 5 6 7 8 9 10 11 | { "status":200, "error":false, "requesitions":"1", "limit":"100", "remainder":99, "whitelist":false, "blocked":false, "client":"Usuario Teste", "api_key":"625v39165efy8mpum9da" } |
Ou, dependendo da sua escolha, o resultado também pode ser formatado em XML, como mostrado abaixo:
1 2 3 4 5 6 7 8 9 10 11 12 | <?xml version="1.0" encoding="UTF-8"?> <item> <status>200</status> <error>false</error> <requesitions>2</requesitions> <limit>100</limit> <remainder>98</remainder> <whitelist>false</whitelist> <blocked>false</blocked> <client>Usuario Teste</client> <api_key>625v39165efy8mpum9da</api_key> </item> |
Para decodificá-lo, você pode utilizar a classe existente no próprio site do JSON. Vale lembrar que os resultados podem ser retornados nos formatos JSON ou XML, são os únicos trabalhados pela API, e que podem ser lidos através de qualquer linguagem. Este foi apenas um exemplo em PHP, o que não impede de ser acessível também ao JAVA, ASP.NET, C#, PHYTON e etc.
Não se esqueça! Lembre-se de ler a Documentação Completa da API para entender o seu funcionamento.
Utilizando PHP + cURL para realizar as requisições no Projeto Aelle.
O cURL é mais completo do que o Snoopy, e é o que recomendo aos usuários que optam por uma consulta mais arrojada, pode parecer um pouco complexo mas não é, uma documentação completa sobre o cURL você encontra no próprio site do PHP.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | //Defino uma variável onde posso guardar a Chave da API //E também a URL de consulta $chaveAPI = "625v39165efy8mpum9da"; $urlConsulta = "http://api.projetoaelle.com/1/info/user/".$chaveAPI.":json"; //Inicia a sessão $session = curl_init($urlConsulta); curl_setopt($session,CURLOPT_HEADER,false); curl_setopt($session,CURLOPT_USERAGENT,"Foco Livre Exemplo (Teste do Blog; PT-BR) v1.0"); curl_setopt($session,CURLOPT_REFERER,"http://blog.focolivre.com/"); curl_setopt($session,CURLOPT_FOLLOWLOCATION,1); curl_setopt($session,CURLOPT_TIMEOUT,10); curl_setopt($session,CURLOPT_RETURNTRANSFER,true); //Chama as informações da página $page = curl_exec($session); //Imprime o resultado em JSON ou XML //Dependendo da requisição que foi realizada. echo $page; |
O resultado retornado é o mesmo que foi exibido acima, e no caso do JSON você também precisará da biblioteca para decodificá-lo.
