Solicitar tu primera API en Atajos en el iPhone o iPad
Para solicitar tu primera API, crea la URL que apunta al "punto final" de la API con la cual te quieres comunicar y luego pasa esa URL a la acción "Obtener contenido de URL". Cuando se ejecute el atajo, esta acción crea la solicitud de API.
Crear la solicitud de API
El punto final de Typicode requiere una solicitud de URL con el siguiente formato:
https://jsonplaceholder.typicode.com/[RESOURCE]
El texto entre paréntesis es el recurso al que quieres acceder. Typicode proporciona muchos ejemplos diferentes para probar las solicitudes. Este ejemplo usará https://jsonplaceholder.typicode.com/users para solicitar una lista de usuarios.
En la app Atajos en tu dispositivo iOS o iPadOS, agrega la solicitud a la dirección URL.
La solicitud
userssolicitará una lista de usuarios.Puedes refinar tu búsqueda al especificar el identificador de un usuario específico:
https://jsonplaceholder.typicode.com/users/6. Esto devolverá el usuario cuyo identificador sea 6.La mayoría de las API permiten realizar consultas utilizando el siguiente formato:
https://jsonplaceholder.typicode.com/users?username=Bret. El símbolo “?” inicia la consulta, para buscar elementos utilizando pares clave/valor. En este ejemplo, la consulta?username=Bretbusca un usuario cuyo nombre de usuario es Bret.Consulta la documentación de tu API para obtener información sobre las búsquedas y consultas compatibles.
Realizar una solicitud de API con la acción "Obtener contenido de URL"
En la app Atajos en tu dispositivo iOS o iPadOS, toca “Mostrar más” en la acción “Obtener contenido de URL”.
Se mostrarán las siguientes opciones de tipos de solicitudes de API que puedes realizar:
GETte permite obtener datos.POSTte permite crear datos nuevos.PUTte permite actualizar datos mediante su reemplazo.PATCHte permite actualizar datos mediante su edición.DELETEte permite eliminar un objeto determinado en la solicitud URL.
Para este ejemplo, usa una solicitud
GETpara obtener datos de la API de Typicode.Ahora que la acción Dirección URL tiene tu solicitud y configuraste la acción "Obtener contenido de URL" para
GETdatos, estás listo para realizar tu solicitud de API.Nota: cuando la acción "Obtener contenido de URL" cambia a
POST,PUToPATCH, se agrega un nuevo parámetro llamado "Solicitar cuerpo". "Solicitar cuerpo" te permite enviar JSON, un Formulario o un Archivo a la API como parte de tu solicitud. Esto te permite ingresar datos manualmente o mediante variables para enviar datos a la API con el objetivo de crear, reemplazar o modificar una entrada.Para probar el atajo, toca
.
A primera vista, parece que la API devuelve una mezcla incomprensible de texto . Estos datos están codificados en JSON, que significa notación de objetos JavaScript.
Para aprender a trabajar con JSON y continuar con el ejemplo de la API de Typicode, consulta Introducción al uso de JSON en Atajos en el iPhone y iPad.