Las API, abreviatura de Interfaces de programación de aplicaciones, son interfaces entre software y software. Esto significa que permiten que diferentes aplicaciones se comuniquen entre sí e intercambien información o funciones. Esto permite a las empresas acceder a datos, fragmentos, software o servicios de terceros para ampliar la funcionalidad de sus propios productos, todo mientras ahorra tiempo y dinero.
Ahora que comprende los beneficios, es posible que se pregunte exactamente cómo usar la API para solicitar y recuperar datos de otra aplicación. Aquí es donde entran las llamadas a la API.
¿Qué es una llamada API?
Una llamada API es el proceso mediante el cual una aplicación cliente envía una solicitud a la API y esa API obtiene los datos solicitados de un servidor o programa externo y los devuelve al cliente.
Suponga que su aplicación utiliza las API de Facebook para extraer datos y funciones de la plataforma. En este caso, cuando transmite una transmisión de video en vivo en Facebook, crea una publicación o crea un tablero personalizado para sus anuncios, en realidad está haciendo una llamada a la API.
Ahora que entendemos qué es una llamada API, analicemos el proceso de creación.
Cómo hacer llamadas a la API
- Encuentre el URI del servidor o programa externo.
- Agregue una solicitud HTTP.
- Incluye un encabezado.
- Incluya una clave de API o un token de acceso.
- Espere una respuesta.
1. Busque el URI del servidor o programa externo.
Para realizar una llamada a la API, lo primero que debe saber es la URI (Uniform Resource Identifier) del servidor o programa externo cuyos datos desea. Es básicamente el equivalente digital de la dirección de su casa. Sin él, no sabrá dónde enviar su solicitud.
Por ejemplo, el URI de la API de HubSpot es https://api.hubapi.com.
Tenga en cuenta que la mayoría de las API tienen puntos finales diferentes, cada uno con sus propias rutas de puntos finales. Por ejemplo, supongamos que desea transmitir tweets públicos en tiempo real. Entonces puedes usar El punto final filtrado de la transmisión de Twitter. La ruta principal que es común a todos los puntos finales es https://api.twitter.com. El punto final filtrado de la transmisión es / 2 / tweets / search / stream. Puede agregar esto al final de la ruta base o simplemente mencionar el punto final en la solicitud.
2. Agregue una solicitud HTTP.
Una vez que haya obtenido el URI, necesita saber cómo formular la solicitud.
Lo primero que debe considerar es el verbo de la solicitud. Los cuatro verbos de petición más básicos son:
- OBTENER: Para descargar un recurso
- OFICINA DE CORREOS: Para crear un nuevo recurso
- PONER: Para editar o actualizar un recurso existente
- ELIMINAR: Para eliminar un recurso
Por ejemplo, suponga que está utilizando la API de estaciones de combustible alternativo NREL y desea ver una lista de las estaciones de combustible alternativo más cercanas en Denver, Colorado. Luego puede hacer una solicitud GET que podría verse así:
GET https://developer.nrel.gov/api/alt-fuel-stations/v1/nearest.json?api_key=XXXXXXXXX&location=Denver+CO
Esto le dice al servidor que busque en la base de datos para encontrar una lista de gasolineras alternativas en Denver. Si existe una lista de este tipo, el servidor devolverá una copia de este recurso en formato XML o JSON y un código de respuesta HTTP 200 (OK). Si esta lista no es así, devolverá el código de respuesta HTTP 404 (No encontrado).
Aquí hay un vistazo a la salida JSON:
Si no está familiarizado con JSON, esto puede parecer intimidante. Entonces puede usar Excel para hacer la llamada y obtener una lista simple de cinco estaciones alternativas.
3. Incluya un encabezado.
Lo siguiente que debe incluir es un encabezado que le informe a la API sobre la solicitud y la respuesta esperada. Incluir un encabezado garantiza que la API comprenda lo que está solicitando y responda como se esperaba y sea fácil de entender y usar. Los tres encabezados comunes son agente de usuario, tipo de contenido y aceptación. Vamos a definir cada uno a continuación.
Agente de usuario
Este encabezado permite a los servidores identificar la aplicación, el sistema operativo, el proveedor y/o la versión del agente de usuario que realiza la solicitud.
Por ejemplo, suponga que desea que su aplicación funcione con las API RESTful New Relic. Entonces necesita un agente HTTP para administrar el intercambio de información entre su aplicación y New Relic, y necesita identificar esta integración. En este caso, el siguiente encabezado de cliente de usuario de Java se debe pasar usando el verbo GET:
get.setHeader("User-Agent", "my-integration/1.2.3");
el tipo de contenido
Este encabezado explica qué tipo de información hay en el cuerpo de la solicitud. Puede explicar que la solicitud se formateó, por ejemplo, en XML o JSON. Sin este encabezado, la API podría recibir su solicitud y no entender qué es o cómo decodificarla. Como resultado, no recibirá una respuesta.
Aceptar
Este encabezado explica en qué formato desea recibir la respuesta de la API. Sin este encabezado, la API puede devolver los datos solicitados en XML cuando lo desee en JSON, o viceversa.
Tenga en cuenta que es posible que la API no pueda devolver datos en el formato solicitado. Puede ser frustrante, pero obtendrá la respuesta de todos modos. Por lo tanto, siempre debe incluir este encabezado en su llamada a la API en caso de que pueda obtener la respuesta exacta que necesita.
4. Incluya una clave de API o un token de acceso.
La clave de API y el token de acceso tienen el mismo propósito: son identificadores únicos que se utilizan para autenticar las llamadas a la API. Consiste en una cadena de letras y números que identifican la aplicación del cliente que envía la solicitud, la clave API o el token de acceso se utiliza para otorgar o denegar solicitudes en función de los privilegios de acceso del cliente y rastrear la cantidad de solicitudes realizadas con fines de uso y facturación.
Para llamar a una API a la API de Google Cloud Natural Language, debe incluir la clave de API como parámetro de consulta. Por ejemplo, suponga que desea encontrar entidades con nombre (es decir, nombres propios y sustantivos comunes) en el cuerpo del texto. Luego haga la siguiente solicitud de API, reemplazando API_KEY con su clave de API real:
POST https://language.googleapis.com/v1/documents:analyzeEntities?key=API_KEY
5. Espere una respuesta.
Ahora todo lo que queda es esperar la respuesta de la API. Puede esperar un código de estado que le indique que la solicitud se procesó correctamente o sin éxito. En este último caso, el código de estado explicará el problema para que puedas solucionarlo e intentarlo de nuevo. Los códigos más comunes son los códigos 2XX («Códigos de éxito») y los códigos 4XX («Códigos de error»). Veamos algunos de los más comunes:
códigos 2XX
Estos códigos indican que el servidor recibió la solicitud del cliente y la procesó con éxito. Los ejemplos más comunes son:
- 200 bien: La solicitud fue exitosa.
- 201 Creado: El recurso fue creado en el servidor. Esta respuesta generalmente se devuelve para solicitudes POST.
- 202 Aceptado: La solicitud ha sido recibida pero aún se está procesando.
- 204 Sin contenido: La solicitud se procesó correctamente, pero no se devolvió ningún contenido.
códigos 4XX
Estos códigos indican que la solicitud del cliente contiene un error. Es posible que la solicitud esté mal escrita o que el recurso que el cliente está solicitando no exista.
- 400 malas demandas: Hay algo mal con la solicitud del cliente.
- 401 no autorizado: El cliente no está autorizado para ejecutar esta solicitud.
- 403 Prohibido: La solicitud es válida pero no se puede procesar. Probablemente el problema es que el cliente no tiene los permisos requeridos.
- 404 No encontrado: El recurso solicitado no existe.
Probar llamadas a la API
Hay API para aparentemente todo hoy en día, desde publicar fotos de Instagram en su sitio de comercio electrónico abajo proporcionando acceso a miles de hoteles en tu blog.
Con tantas API para elegir, es importante evaluarlas cuidadosamente en cuanto a funcionalidad, confiabilidad, rendimiento y seguridad para asegurarse de que satisfagan las necesidades de su aplicación y sus usuarios. Si está creando, suministrando y manteniendo la API, las pruebas son igual de importantes. Las pruebas frecuentes garantizarán que la API sea funcional y cumpla con las expectativas del consumidor.
Ahora que entendemos la importancia de las pruebas de API, definamos qué es exactamente.
Cómo realizar pruebas de API
Las pruebas de API consisten en realizar llamadas de API a diferentes puntos finales, obtener respuestas y verificar códigos de estado, tiempos de respuesta y datos en esas respuestas.
Este tipo de prueba generalmente lo realiza una herramienta de software o un servicio web, p. ReqBin. El proceso es relativamente similar, pero los pasos exactos variarán según la herramienta o el servicio que esté utilizando. A continuación se muestran los pasos para probar la API con ReqBin. Para esta demostración, probaremos la API abierta y gratuita.
1. Introduzca la URL del punto final de la API.
Suponga que desea utilizar la API de búsqueda de artículos del New York Times para buscar artículos con la palabra clave «perro». Luego utilizará la siguiente URL: https://api.nytimes.com/svc/search/v2/articlesearch.json?q=dog.
2. Seleccione el método HTTP apropiado.
Como desea descargar artículos con esta palabra clave, utilizará el método GET.
Recuerde que si está utilizando los métodos POST, PUT o PATCH, ingrese los datos en la pestaña Contenido.
3. Ingrese sus credenciales en la pestaña Autorización.
Si el servidor API requiere autorización, debe ingresar sus credenciales en la pestaña Autorización. Veamos qué pasa si te saltas este paso.
4. Haga clic en Enviar para enviar la solicitud de API.
Después de enviar la solicitud de API, puede ver el código de estado de API devuelto, el tiempo de respuesta y el cuerpo.
Tenga en cuenta que en este caso recibió una respuesta no autorizada 401. Esto se debe a que necesita una clave de API para usar esta API de NYT.
Después de obtener la clave de API, puede continuar con las pruebas cambiando la URL del extremo de la API, el método HTTP y los datos de la solicitud.
Haz una llamada
Ahora que sabe cómo probar una llamada API, puede comenzar a evaluar las diferentes API y reducir la selección que mejor se adapte a su aplicación y usuarios. Luego, cuando esté listo para conectar su aplicación con el resto del mundo del software, puede hacer la llamada.
