Solicite sua primeira API no Atalhos do iPhone ou iPad
Para solicitar a primeira API, crie um URL que aponte para o “endpoint” da API com a qual deseja se comunicar e passe o URL à ação “Obter Conteúdo do URL”. Quando o atalho é executado, essa ação faz a solicitação de API.
Construa a solicitação de API
O endpoint do Typicode requer que a solicitação de URL seja formatada desta maneira:
https://jsonplaceholder.typicode.com/[RESOURCE]
O texto entre colchetes é o recurso que você deseja acessar. Typicode fornece muitos exemplos diferentes para solicitações de teste. Este exemplo vai usar https://jsonplaceholder.typicode.com/users para solicitar uma lista de usuários.
No app Atalhos no dispositivo iOS ou iPadOS, adicione a solicitação ao URL.
A solicitação de
usersretornará uma lista de usuários.Você pode especificar um usuário pelo id para restringir a pesquisa:
https://jsonplaceholder.typicode.com/users/6. Será retornado um usuário com id igual a 6.A maioria das APIs permite consultas usando o seguinte formato:
https://jsonplaceholder.typicode.com/users?username=Bret. O caractere “?” inicia a consulta, que busca itens que usam os pares de chave/valor. Neste exemplo, a pesquisa?username=Bretbusca um usuário de nome Bret.Verifique a documentação da API para buscas e pesquisas compatíveis.
Faça a solicitação de API com a ação Obter Conteúdo de URL
No app Atalhos do dispositivo iOS ou iPadOS, toque em Mostrar Mais na ação “Obter Conteúdo do URL”.
As seguintes opções dos tipos de solicitação de API que podem ser feitas são disponibilizadas:
GETpermite recuperar dados.POSTpermite criar novos dados.PUTpermite substituir dados para atualizá-los.PATCHpermite modificar dados para atualizá-los.DELETEpermite remover um objeto especificado na solicitação URL.
Para este exemplo, use uma solicitação
GETpara obter dados da API Typicode.Agora que a ação URL tem a solicitação e a ação “Obter Conteúdo do URL” está configurada para
GET(obter) dados, a solicitação de API pode ser feita.Nota: quando a ação “Obter Conteúdo do URL” é alternada para
POST(publicar),PUT(colocar) ouPATCH(modificar), um novo parâmetro, chamado Pedir Corpo, é adicionado. Pedir Corpo permite que você envie um JSON, um Formulário ou um Arquivo à API, como parte da sua solicitação. Isso permite que você digite novos dados manualmente ou use variáveis para enviar os dados à API para criar, substituir ou modificar uma entrada.Para testar o atalho, toque em
.
À primeira vista, a API parece retornar um texto bagunçado. Esses dados são codificados em formato JSON, que significa JavaScript Object Notation (em inglês).
Para saber mais sobre como trabalhar com JSON e prosseguir com o exemplo da API Typicode, consulte Introdução ao uso de JSON no Atalhos do iPhone e iPad.