Efetuar o primeiro pedido à API na aplicação Atalhos no Mac
para efetuar o primeiro pedido à API, tem de criar um URL que aponta para o “ponto terminal” da API com a qual pretende comunicar e, em seguida, passar esse URL para a ação “Obter conteúdo do URL”. Quando o atalho é executado, esta ação efetua o pedido à API.
Criar o pedido à API
O ponto final de Typicode exige que um pedido de URL esteja formatado da seguinte forma:
https://jsonplaceholder.typicode.com/[RESOURCE]
O texto entre parênteses retos é o recurso a que gostaria de aceder. Typicode disponibiliza vários exemplos para testar pedidos. Este exemplo usará https://jsonplaceholder.typicode.com/users para pedir uma lista de utilizadores.
Na aplicação Atalhos
no Mac, adicione o pedido ao URL.O pedido
usersdevolverá uma lista de utilizadores.Pode limitar a pesquisa especificando um utilizador em específico pelo id:
https://jsonplaceholder.typicode.com/users/6. Isso devolverá o utilizador cuja id é 6.A maioria das API permitem consultas com o seguinte formato:
https://jsonplaceholder.typicode.com/users?username=Bret. O “?” inicia a consulta, que procura elementos com pares de chaves/valores. Neste exemplo, a consulta?username=Bretprocura por um utilizador cujo nome de utilizador é Bret.Consulte a documentação da API para pesquisas e consultas compatíveis.
Efetuar o pedido à API com a ação “Obter conteúdo do URL”
Na aplicação Atalhos
no Mac, clique em “Mostrar mais” na ação “Obter conteúdo do URL”.As seguintes opções para os tipos de pedido à API que pode efetuar ficam disponíveis:
GETpermite-lhe obter dados.POSTpermite-lhe criar novos dados;PUTpermite-lhe atualizar dados substituindo-os.PATCHpermite-lhe atualizar dados modificando-os.DELETEpermite-lhe remover um objeto especificado no pedido de URL.
Para este exemplo, use um pedido
GETpara obter dados da API Typicode.Agora que a ação URL tem o seu pedido e a ação “Obter conteúdo do URL” está configurado para
GETdados, está pronto para efetuar o pedido à API.Nota: Quando a ação “Obter conteúdo do URL” muda para
POST,PUTouPATCH, é adicionado um novo parâmetro denominado “Pedir corpo”. O parâmetro “Pedir corpo” permite-lhe enviar JSON, um formulário ou um ficheiro à API como parte do seu pedido. Desta forma, pode introduzir novos dados de forma manual ou através de variáveis, para que possa enviar dados à API para criar, substituir ou modificar uma entrada.Para testar o atalho, clique em
.À primeira vista, a API parece devolver uma grande quantidade de texto. Estes dados estão codificados em JSON, que é a abreviatura de JavaScript Object Notation.
Encontrará informação adicional sobre como trabalhar com JSON e continuar o exemplo API do Typicode em Introdução à utilização de JSON na aplicação Atalhos no Mac.