El Proyecto | Sobre nosotros | Contribuir | Donaciones | Licencia
HOME Mis cursos Finalizados
◄ Anterior
◄

Uso de PowerShell con REST APIs

Siguiente ►
►

En este tema, aprenderemos cómo utilizar PowerShell para interactuar con APIs RESTful. Las APIs RESTful son una forma común de permitir la comunicación entre diferentes sistemas a través de HTTP. PowerShell, con su capacidad de manejar solicitudes HTTP, es una herramienta poderosa para trabajar con estas APIs.

Conceptos Clave

  1. API RESTful: Una API que sigue los principios de REST (Representational State Transfer), utilizando métodos HTTP estándar como GET, POST, PUT y DELETE.
  2. HTTP Verbs: Métodos HTTP utilizados para realizar acciones en recursos. Los más comunes son GET (obtener datos), POST (enviar datos), PUT (actualizar datos) y DELETE (eliminar datos).
  3. Endpoints: URLs específicas en una API donde se pueden realizar acciones.
  4. Headers: Información adicional enviada con una solicitud HTTP, como la autenticación o el tipo de contenido.
  5. Payload: Datos enviados en el cuerpo de una solicitud HTTP, generalmente en formato JSON o XML.

Ejemplo Práctico: Consumiendo una API RESTful

Paso 1: Realizar una Solicitud GET

Primero, realizaremos una solicitud GET para obtener datos de una API pública. Utilizaremos la API de JSONPlaceholder, que es una API de prueba gratuita.

# URL del endpoint
$url = "https://jsonplaceholder.typicode.com/posts"

# Realizar la solicitud GET
$response = Invoke-RestMethod -Uri $url -Method Get

# Mostrar la respuesta
$response

Explicación:

  • Invoke-RestMethod: Cmdlet de PowerShell utilizado para realizar solicitudes HTTP.
  • -Uri: Especifica la URL del endpoint.
  • -Method Get: Indica que estamos realizando una solicitud GET.

Paso 2: Realizar una Solicitud POST

Ahora, enviaremos datos a la API utilizando una solicitud POST. Enviaremos un nuevo post a la misma API.

# URL del endpoint
$url = "https://jsonplaceholder.typicode.com/posts"

# Datos a enviar en formato JSON
$postData = @{
    title = "foo"
    body = "bar"
    userId = 1
} | ConvertTo-Json

# Realizar la solicitud POST
$response = Invoke-RestMethod -Uri $url -Method Post -Body $postData -ContentType "application/json"

# Mostrar la respuesta
$response

Explicación:

  • -Body $postData: Especifica los datos que se enviarán en el cuerpo de la solicitud.
  • -ContentType "application/json": Indica que el contenido enviado es de tipo JSON.
  • ConvertTo-Json: Convierte un objeto de PowerShell a formato JSON.

Paso 3: Realizar una Solicitud PUT

Para actualizar un recurso existente, utilizamos una solicitud PUT. Actualizaremos un post existente.

# URL del endpoint
$url = "https://jsonplaceholder.typicode.com/posts/1"

# Datos a actualizar en formato JSON
$updateData = @{
    id = 1
    title = "foo updated"
    body = "bar updated"
    userId = 1
} | ConvertTo-Json

# Realizar la solicitud PUT
$response = Invoke-RestMethod -Uri $url -Method Put -Body $updateData -ContentType "application/json"

# Mostrar la respuesta
$response

Explicación:

  • -Method Put: Indica que estamos realizando una solicitud PUT para actualizar un recurso.

Paso 4: Realizar una Solicitud DELETE

Finalmente, eliminaremos un recurso utilizando una solicitud DELETE.

# URL del endpoint
$url = "https://jsonplaceholder.typicode.com/posts/1"

# Realizar la solicitud DELETE
$response = Invoke-RestMethod -Uri $url -Method Delete

# Mostrar la respuesta
$response

Explicación:

  • -Method Delete: Indica que estamos realizando una solicitud DELETE para eliminar un recurso.

Ejercicio Práctico

Ejercicio 1: Obtener Información de Usuarios

Utilizando la API de JSONPlaceholder, realiza una solicitud GET para obtener información de los usuarios y muestra los nombres de los usuarios.

Solución:

# URL del endpoint
$url = "https://jsonplaceholder.typicode.com/users"

# Realizar la solicitud GET
$response = Invoke-RestMethod -Uri $url -Method Get

# Mostrar los nombres de los usuarios
$response | ForEach-Object { $_.name }

Ejercicio 2: Crear un Nuevo Comentario

Envía un nuevo comentario a la API utilizando una solicitud POST. El comentario debe tener un postId de 1, un name, un email y un body.

Solución:

# URL del endpoint
$url = "https://jsonplaceholder.typicode.com/comments"

# Datos del comentario en formato JSON
$commentData = @{
    postId = 1
    name = "New Comment"
    email = "[email protected]"
    body = "This is a new comment."
} | ConvertTo-Json

# Realizar la solicitud POST
$response = Invoke-RestMethod -Uri $url -Method Post -Body $commentData -ContentType "application/json"

# Mostrar la respuesta
$response

Conclusión

En esta sección, hemos aprendido cómo utilizar PowerShell para interactuar con APIs RESTful. Hemos cubierto cómo realizar solicitudes GET, POST, PUT y DELETE, y cómo manejar datos en formato JSON. Estos conocimientos son fundamentales para automatizar tareas y trabajar con servicios web en PowerShell.

En el siguiente módulo, exploraremos cómo PowerShell puede integrarse con DevOps y cómo utilizarlo en pipelines de CI/CD.

◄ Anterior
◄
Siguiente ►
►

Curso de PowerShell

Módulo 1: Introducción a PowerShell

Módulo 2: Scripting Básico

Módulo 3: Trabajando con Objetos

Módulo 4: Técnicas Avanzadas de Scripting

Módulo 5: Automatización y Programación de Tareas

Módulo 6: PowerShell Remoting

Módulo 7: Funcionalidades Avanzadas de PowerShell

Módulo 8: PowerShell y DevOps

Módulo 9: Mejores Prácticas y Consejos Avanzados

El Proyecto | Sobre nosotros | Contribuir | Donaciones | Licencia
© Copyright 2024. Todos los derechos reservados