Qué es una API: endpoint, ruta, parámetro y autenticación

Si estás iniciando en el desarrollo o programación, en algún momento tendrás que conocer qué es una API y para qué sirve. Si bien en el camino del desarrollador hay varios conocimientos ha obtener, conocer una API es fundamental para cualquier proyecto, aplicación o lenguaje.

En sus siglas API significa application programming interface: es un conjunto de comandos, funciones, protocolos y objetos que los programadores podemos usar para crear software o interactuar con un sistema externo. En otras palabras, cuando buscamos usar servicios externos a nuestro proyecto como servicios de email marketing, o almacenamiento, debemos usar una API proporcionada por el servicio buscado.

Lo que vas a necesitar

Comparto aquí los primeros enlaces que vamos a usar de aquí en adelante:

Para qué sirve una API

qué es una api
Para qué sirve una API
Qué es una API: endpoint, ruta, parámetro y autenticación

Si estás iniciando en el desarrollo o programación, en algún momento tendrás que conocer qué es una …

Qué es bootstrap y cómo usar: formularios, botones, colores y más

Si estás buscando ser más eficiente y eficaz en tu código, con el diseño de tu web o front end, usar…

git remote: cómo funciona la conexión de repositorios

Aprender a conectar nuestro código con repositorios externos es clave para una buena ejecución y git…

Cuando estamos desarrollando ya sea una aplicación móvil o web, en la mayoría (por no decir todas) de veces vamos a necesitar agentes o servicios externos para poder completar funciones clave. Tenemos que tener claro que usar información o recursos de otras empresas con experiencia en el servicio que buscamos, es más un beneficio que una dependiencia.

Hay muchos ejemplos del uso de una API pero aquí van algunos:

  • Almacenamiento en la nube: un hosting para desarrollo como heroku, no incluye el almacenamiento de archivos, solo resguarda el código como tal. Al buscar almacenamiento si o si vamos a encontrar diferentes servicios que otorgarán por medio de una API el uso de lo mismos.
  • Email marketing: para crear listas de difusión, remarketing, o siemplemente para un correo de bienvenida a una lista, es necesario un proveedor del servicio como Mailchimp. Este nos otorga el servicio vía API para poder gestionar nuestros contactos y crecer como empresa digitalmente.

Teniendo estos ejemplos claros, vamos a ver algunos conceptos clave de una API.

EndPoint

qué es una api
API Joke

cada aPI que interactúa con un sistema externo tendrá un punto final o EndPoint. Este es la url de inicio. Un EndPoint de una API es desde donde se recibe una solicitud o llamada. Para el ejemplo usaremos el sitio: https://sv443.net/jokeapi/v2/

Básicamente la API del sitio nos otorga bromas en cada solicitud y conforme a los conceptos que veremos podemos determinar filtros o cantidad. Pero hablando exclusivamente del EndPoint es es inicio de la url ANTES de comenzar a modificarla para obtener datos. Entonces el EndPoint en este caso es la url https://sv443.net/jokeapi/v2/

Path: ruta de API

qué es una api
Ruta de API

La ruta o PATH se usa para limitar un dato específico que desee de un servidor externo. Entonces, modificando la URL de inicio, agregando ciertos argumentos o factores de cambio según la información de la API, se obtendrán datos diferentes.

En el ejemplo de la imagen anterior podemos ver que la URL inicial es: https://v2.jokeapi.dev/joke/ pero al añadir la ruta Programing vamos a obtener solo bromas enfocadas a esta categoría. Es decir, que la API buscará en la base de datos de sus bromas, unas que tengan o estén categorizadas así, y luego las veremos como respuesta a la Solicitud, en la parte inferior.

Paramenter: parámetros de API

parameter API

Este caso es exclusivo para API’s con una gran cantidad de datos, las cuales permitan crear ciertos filtros o consultas personalizados más de lo normal. A diferencia de la ruta, un parámetro entra a ser mucho más especifico que, como en el caso anterior, una categorización.

Por ejemplo en la imagen previa, sí añadimos una búsqueda por string: «node», nos devolverá solo los resultados de bromas que contengan este string. Una búsqueda o filtro más especifico dentro de la base de datos.

Autenticación

Precios Open weather

Por último dejo autenticación porque suele ser lo más complejo. Existen servicios que necesitan cobrar por la información que ofrecen. El caso que usaremos será el la API del servicio meteorológico Open weather map. Acceder a sus datos tiene una versión gratuita hasta ciertas solicitudes, pero luego si se genera un cobro.

Simplemente piénsalo de esta forma: esta empresa gestiona la inversión e investigación para poder obtener datos o métricas meteorológicas. Su producto es esta información por ende, quien la necesite tendrá que pagar por ella. Claro que depende la cantidad de las solicitudes.

Api key

API key open weather

Lo primero a hacer para poder obtener estos datos es crear una cuenta y obtener una API gratuita. Haz click aquí para poder acceder a este servicio. Una vez te registres y tengas la API KEY, procederemos a continuación con la información.

Documentación

qué es una api
Documentación de API.

Haz click aquí para poder ver la información para obtener los datos de la documentación. En la imagen anterior y en el link podremos ver que podemos encontrar información meteorológica buscando por el nombre de la ciudad. Aquí te dejo un ejemplo de la misma documentación.

https://api.openweathermap.org/data/2.5/weather?q=London&appid={API key}

En el ejemplo podemos ver que tenemos varios parámetros como q, el cual como valor debe contener el nombre de la ciudad. appid contiene como valor key de la api obtenida gratuitamente unos pasos arriba. Luego podemos añadir los parámetros opcionales, pero como tal vemos que la documentación nos da toda la información.

Probar API con Postman

qué es una api
Parámetros en Postman

Una vez teniendo claro cuales son los parámetros que queremos implementar lo que debemos ahcer es copiar únicamente el EndPoint o url de inicio de la API. En este caso es:

https://api.openweathermap.org/data/2.5/weather

Copia y pega en el campo principal de la api, justo al lado de get. Si GET, este nos permite obtener información de la API. A continuación, en la opción Params, vamos a ingresar en key: q, appid y uno adicional que deseemos. Igualmente en sus valores, vamos a ingresar tanto el nombre de la ciudad, como la API Key.

Al terminar, haz click en Send. Enviamos la solicitud y como respuesta en la parte inferior se obtendrá en formato JSON los datos meteorológicos. De esta manera obtenemos los datos de una API de servicios externos para nuestro uso.

{
    "coord": {
        "lon": -74.0817,
        "lat": 4.6097
    },
    "weather": [
        {
            "id": 802,
            "main": "Clouds",
            "description": "scattered clouds",
            "icon": "03n"
        }
    ],
    "base": "stations",
    "main": {
        "temp": 283.88,
        "feels_like": 283.44,
        "temp_min": 283.88,
        "temp_max": 283.88,
        "pressure": 1026,
        "humidity": 93
    },
    "visibility": 10000,
    "wind": {
        "speed": 1.03,
        "deg": 0
    },
    "clouds": {
        "all": 40
    },
    "dt": 1665993262,
    "sys": {
        "type": 1,
        "id": 8582,
        "country": "CO",
        "sunrise": 1666003269,
        "sunset": 1666046511
    },
    "timezone": -18000,
    "id": 3688689,
    "name": "Bogota",
    "cod": 200
}

Video de ayuda

Hice este video para guiar el proceso. Si te gusta no olvides dar like y suscribirte para nuevos videos!

Qué es una API

Producto sugerido

Si eres como yo que pasa bastatne tiempo frente al compu, puede que la barra de luz te sirva bastante para cuidar tu vista en esas largas jornadas. También te dejo aquí el post para que veas la reseña completa.

LAMPARA – 4528 valoraciones

Quntis Lámpara para monitor de computadora, barra de luz para monitor de pantalla para el cuidado de los ojos, lámpara de tareas LED de lectura electrónica con atenuación automática, barra de lámpara regulable, control táctil, sin deslumbramiento de pantalla, ahorro de espacio, lámparas de escritorio para oficina en casa

  • Sin reflejos de pantalla y sin parpadeo, antiluz azul: la barra de luz para monitor de computadora Quntis tiene un diseño óptico asimétrico único que ilumina solo tu escritorio y teclado mientras garantiza que no se reflejen en la pantalla. Gracias a su avanzado sistema de protección ocular, nuestras lámparas de escritorio para oficina en casa bloquean la luz azul y la radiación óptica, aliviando eficazmente la fatiga ocular para proteger tus ojos. Es la opción ideal para estudiantes, diseñadores de pintura y trabajadores de oficina de negocios.

VER EN AMAZON

Conclusión

Conocer el funcionamiento o fundamentos de la API es clave para cualquier desarrollo. En cualquier momento podremos necesitar servicios que requieran por ejemplo una autenticación y para esto, probar la api y gestionar los datos, es de vital importancia.

¿De cuánta utilidad te ha parecido este contenido?

¡Haz clic en una estrella para puntuar!

Promedio de puntuación 0 / 5. Recuento de votos: 0

Hasta ahora, ¡no hay votos!. Sé el primero en puntuar este contenido.

Ya que has encontrado útil este contenido...

¡Sígueme en los medios sociales!

Resumen
Qué es una API | Cómo funciona | ruta y parámetro | Autenticación
Nombre del artículo
Qué es una API | Cómo funciona | ruta y parámetro | Autenticación
Descripción
Si estás buscando qué es una API y para qué sirve en el desarrollo móvil o web, haz click aquí para conocer los fundamentos ✅
Autor
Publisher Name
Eduardo Arias
Publisher Logo
guest

0 Comments
Comentarios en línea
Ver todos los comentarios