¿Qué es la API REST y cómo puede obtener datos para su aplicación o sitio web?

El acrónimo API significa interfaz de programación de aplicaciones. Un API es un conjunto de funciones que facilita la comunicación entre dos aplicaciones de software. Esencialmente, un API toma una solicitud de una aplicación de software a otra, luego regresa al software de inicio con una respuesta relevante.

DESCANSAR significa transferencia de estado representacional y es una arquitectura que se utiliza para diseñar aplicaciones cliente-servidor. Con un API de descanso, obtiene una representación de los datos solicitados almacenados en una base de datos. A API REST tampoco tiene estado, lo que significa que el servidor no almacena ningún dato entre las solicitudes de los clientes.

Si estas buscando un API de descanso ejemplo y una explicación detallada de cómo funciona, sigue leyendo.

¿Cómo funciona una API REST?

A API REST accede a los datos a través de identificadores uniformes de recursos (URI), que es una cadena de caracteres que identifica un recurso específico. El tipo de URI utilizado por un API REST es un localizador uniforme de recursos (URL).

Para acceder y manipular recursos, un REST API usa los siguientes verbos de solicitud:

• Obtener (esto se usa para adquirir datos de una base de datos)
• Publicar (agregar nuevos datos a una base de datos)
• Poner (actualizar los datos en una base de datos)
• Eliminar (eliminar datos de una base de datos)

Si desea utilizar los servicios de uno de los muchos API REST disponible en la Web (en lugar de crear uno desde cero), solo tendrá acceso al verbo get request del API REST (a través de una URL). Estas URL tienen varios componentes, pero los que necesita saber son los API clave y la consulta.

los API La clave es un identificador único, que recibirá una vez que se registre en una API REST plataforma. La consulta suele ser una ecuación simple que se utiliza para personalizar su búsqueda. Por lo tanto, si desea obtener el clima actual en la ciudad de Nueva York, la sección de consulta de su URL podría ser "ciudad = Nueva York".

La ejecución de una solicitud de obtención devuelve una respuesta, que contiene un código de estado y un cuerpo. Si la solicitud tiene éxito, su cuerpo de respuesta contendrá los datos que desea utilizar en su sitio web o aplicación.

Uso de una aplicación de JavaScript para obtener datos de diferentes API de descanso

Para crear esta sencilla aplicación, hay otras dos aplicaciones de software que necesita instalar en su computadora: NodeJS y npm. Hemos escrito un artículo sobre cómo instalar NodeJS y npm en Ubuntu, así como uno en cómo hacer esto en Windows—Por tanto, échales un vistazo si quieres obtener más información.

Una vez que las aplicaciones anteriores estén instaladas en su computadora, deberá seguir los siguientes pasos:

1. Abra su IDE y ejecute la terminal.
2. Navegue a la carpeta que contiene su archivo de aplicación JavaScript usando el comando cd.
3. Inicialice npm con la siguiente línea de código:

npm init -y

Hay un módulo npm que desempeñará un papel clave en la funcionalidad de esta aplicación. Este es el módulo got, que es una biblioteca de solicitudes HTTP para NodeJS. La siguiente línea de código instalará la última versión de la biblioteca obtenida en los archivos de su aplicación:

npm install got @ latest

Ahora puede seguir adelante y crear su aplicación.

Uso de la biblioteca Got para crear su aplicación

// importa la biblioteca obtenida a tu aplicación
const got = require ('got');
// recupera datos de una API REST específica e imprime su cuerpo en la terminal
(asíncrono () => {
tratar {
respuesta constante = aguardar conseguido (URL);
datos constantes = JSON.parse (respuesta.cuerpo);
console.log (datos);
} captura (error) {
console.log (error.data);
}
})();

La aplicación anterior tomará datos de cualquier API REST En la red. Sin embargo, primero deberá proporcionar la URL del recurso relevante.

Obtención de datos de una API REST meteorológica

El Weatherbit.io API es uno de los climas más populares API REST. Insertando la URL de este API en la aplicación JavaScript simple anterior hará que la aplicación sea operativa.

Usando la API REST de Weatherbit.io

// importa la biblioteca obtenida a tu aplicación
const got = require ('got');
// recupera datos de una API REST específica e imprime su cuerpo en la terminal
(asíncrono () => {
tratar {
const URL = ' https://api.weatherbit.io/v2.0/current? lat = 40.7128 & lon = -74.0060 & key = API_KEY ';
respuesta constante = aguardar conseguido (URL);
datos constantes = JSON.parse (respuesta.cuerpo);
console.log (datos);
} captura (error) {
console.log (error.data);
}
})();

La URL de Weatherbit.io API ahora se ha insertado correctamente en la aplicación. Sin embargo, hay un aspecto de la URL que debe ajustar para que la aplicación se ejecute. Esta es la sección denominada "API_KEY", y esta clave es la que recibirá de Weatherbit.io cuando se registre para obtener una cuenta gratuita.

También tiene la opción de ajustar la sección de consulta en el código anterior. Actualmente, la aplicación consulta el clima en la latitud de 40.7128 y la longitud de -74.0060, pero puede insertar nuevas coordenadas. Aunque la consulta anterior es el enfoque recomendado, puede buscar el clima en una ubicación utilizando el nombre de la ciudad.

Para obtener más información sobre cómo utilizar Weatherbit.io API REST, haga clic aquí.

Después de insertar su API clave en la sección relevante anterior, ahora puede ejecutar su archivo JavaScript. La aplicación proporcionará algo similar a la siguiente salida en su terminal.

Ejemplo de respuesta de la API REST de Weatherbit.io

datos: [
{
dcha.: 53,
vaina: 'd',
lon: -74.01,
pres: 1005,9,
zona horaria: 'America / New_York',
ob_time: '2021-09-27 14:50',
country_code: 'EE. UU.',
nubes: 25,
ts: 1632754200,
radio_solar: 652,8,
state_code: 'NY',
city_name: 'Ciudad de Nueva York',
wind_spd: 5.66,
wind_cdir_full: 'oeste-suroeste',
wind_cdir: 'WSW',
slp: 1015,9,
vis: 5,
h_angle: -30,
puesta de sol: '22: 44 ',
dni: 851,72,
rocío: 12,
nieve: 0,
uv: 5.68859,
precip: 0,
dirección_de_viento: 240,
amanecer: '10: 49 ',
ghi: 657,55,
dhi: 106,79,
aqi: 53,
latitud: 40,71,
tiempo: [Objeto],
fecha y hora: '2021-09-27: 14',
temp.: 22,
estación: 'KJRB',
elev_angle: 40,89,
app_temp: 21.7
}
],
cuenta: 1
}

Algunos de los aspectos más importantes de los datos devueltos en la respuesta incluyen:

• Nombre de la ciudad (devuelve el nombre de la ciudad con la longitud y latitud indicadas).
• Fecha y hora (devuelve la hora del ciclo actual en el formato AAAA-MM-DD: HH).
• Clima (devuelve un objeto que contiene un icono meteorológico, un código meteorológico y una descripción de texto del tiempo).

Obtención de datos de una API REST de noticias

Las noticias API utilizado en esta sección es Newsdata.io. Como todo API REST en la web, proporciona varias opciones de consulta, que puede utilizar para recuperar noticias de última hora de todo el mundo. Con Newsdata.io API, puede obtener noticias de un país específico o en un idioma, categoría, etc.

Con la aplicación JavaScript, puede recuperar datos de las noticias. API REST. Simplemente reemplace la URL en la aplicación anterior con la siguiente URL:

' https://newsdata.io/api/1/news? apikey = YOUR_API_KEY & country = us '

El siguiente paso es reemplazar la sección "YOUR_API_KEY" en la URL anterior con la API clave que recibirá después de registrarse en Newsdata.io. La URL anterior devolverá noticias de última hora de Estados Unidos. Sin embargo, si desea recibir noticias de Japón, simplemente puede reemplazar la consulta "contry = us" por "country = jp".

Para obtener más información sobre cómo utilizar Newsdata.io API REST, haga clic aquí.

Relacionado: ¿Quiere agregar titulares de noticias a su sitio web o aplicación? Necesita la API de Mediastack

Ejemplo de respuesta de la API REST de Newsdata.io

{
título: 'Conductor asesinado por la puerta de su propio automóvil mientras esperaba en la fila en un servicio de comida rápida, brindando información de precaución para los autos que se conducen por sí mismos con inteligencia artificial',
Enlace: ' https://www.forbes.com/sites/lanceeliot/2021/09/27/driver-killed-by-his-own-car-door-while-waiting-in-line-at-fast-food-drive-thru-providing-cautionary-insights-for-ai-self-driving-cars/',
palabras clave: [Matriz],
creador: [Array],
video_URL: nulo,
description: "Una noticia triste sobre un conductor que murió por la puerta de su propio automóvil (mientras estaba en un drive-thru), brinda información preventiva sobre
el advenimiento de los coches autónomos basados ​​en IA. Aquí está la mirada privilegiada. ",
contenido: "Una noticia triste sobre un conductor que murió por la puerta de su propio automóvil (mientras estaba en un drive-thru), brinda información preventiva sobre el
advenimiento de los coches autónomos basados ​​en IA. Aquí está la mirada privilegiada. ",
pubDate: '2021-09-27 15:30:00',
URL de la imagen: ' https://thumbor.forbes.com/thumbor/fit-in/0x0/filters%3Aformat%28jpg%29/https://specials-images.forbesimg.com/imageserve/614272b9f18bec6882652695/0x0.jpg? cropX1 = 23 & cropX2 = 2455 & cropY1 = 23 & cropY2 = 1538 ',
source_id: 'forbes'
}

Uso de una aplicación de Python para obtener datos de diferentes API de descanso

Es posible obtener datos para su sitio web o aplicación utilizando cualquier lenguaje de programación con el que esté familiarizado. Por lo tanto, si no desea utilizar JavaScript, puede lograr los mismos resultados con una aplicación de Python.

Relacionado: Cómo construir API en Python: marcos populares

Todo lo que necesita hacer es instalar el módulo Python HTTP de solicitudes utilizando el entorno pip. Luego, puede construir su aplicación Python usando el siguiente código:

# importar la biblioteca de solicitudes
solicitudes de importación
# captura de datos usando la biblioteca de solicitudes
URL = ' https://newsdata.io/api/1/sources? apikey = YOUR_API_KEY = nosotros '
res = solicitudes.get (URL)
json = res.json ()
para clave en json:
imprimir (clave, json [clave])

Al igual que en los ejemplos anteriores, deberá insertar su API clave en la sección correspondiente. A continuación, recibirá los mismos datos que devuelve la aplicación JavaScript.

Obtener datos para su sitio web o aplicación es bastante simple

Ahora tiene las herramientas que necesita para capturar datos para sus aplicaciones de software. Es importante recordar que el DESCANSAR La arquitectura facilita el acoplamiento flexible, lo que significa que puede utilizar cualquier lenguaje de programación para obtener datos de cualquier API REST En la red.

Ahora sabes como usar API de descanso, ¿Por qué no darle una oportunidad?

Web Scraping vs. API: ¿Cuál es la mejor forma de extraer datos?

Hay datos en todas partes, pero tenerlos en sus manos es otro problema, si es que es legal.

Leer siguiente

Sobre el Autor