Material de Estudio
Módulo: Reforzamiento Técnico
Curso: Conceptos REST/SOAP API
2023
Material Estudio:
CONTROL DE VERSIÓN
Versión Fecha Descripción Autor
1.0 28/02/2023 Creación de documento Eduardo
Castro
Pág. 2
[Link]
Material Estudio:
Tabla de contenido
Tabla de contenido ........................................................................................................................................ 3
1. Siglas ...................................................................................................................................................... 4
2. ¿Qué es una Rest API? ........................................................................................................................... 4
3. ¿Qué es una SOAP API? ......................................................................................................................... 4
3.1 Uso de SOAP API .................................................................................................................................. 5
Pág. 3
[Link]
Material Estudio:
1. Siglas
Sigla Descripción
API Application Programming Interface
REST Representational State Transfer
SOAP Simple Object Access Protocol
2. Introducción
Una API de REST, o API de RESTful, es una interfaz de programación de aplicaciones
(API o API web) que se ajusta a los límites de la arquitectura REST y permite la interacción
con los servicios web de RESTful. El informático Roy Fielding es el creador de la
transferencia de estado representacional (REST).
Las API son conjuntos de definiciones y protocolos que se utilizan para diseñar e integrar
el software de las aplicaciones. Suele considerarse como el contrato entre el proveedor
de información y el usuario, donde se establece el contenido que se necesita por parte
del consumidor (la llamada) y el que requiere el productor (la respuesta).
En otras palabras, las API le permiten interactuar con una computadora o un sistema para
obtener datos o ejecutar una función, de manera que el sistema comprenda la solicitud y
la cumpla.
SOAP significa Protocolo Simple de Acceso a Objetos. SOAP el API permite que las
aplicaciones se comuniquen entre sí, aunque estén escritas en diferentes lenguajes de
programación. Es un protocolo con más complejidad en términos de seguridad y
comunicación de datos. Dado que este protocolo se ocupa de los mensajes, el objetivo
principal es evitar el acceso no autorizado a través de la seguridad de WS. SOAP La API
utiliza protocolos integrados que hacen que su uso sea complejo.
Pág. 4
[Link]
Material Estudio:
La dificultad de las SOAP API radica en el uso de diferentes lenguajes de programación
para la transmisión de mensajes. SOAP utiliza el formato XML para la comunicación, lo
que la convierte en una API compleja.
3. Objetivo
En el siguiente manual se expone las configuraciones y uso de la herramienta Postman
para consumo de API’s REST & SOAP. Con el propósito de darle una visión a los
desarrolladores del uso de este tipo de API.
Pág. 5
[Link]
Material Estudio:
4. Uso de SOAP API
1.) En Postman vamos a collections, luego presionamos Import.
2.) En la ventana emergente seleccionamos Link y pegamos el siguiente link.
[Link]
3.) Presionamos Importar
Pág. 6
[Link]
Material Estudio:
4.) Cuando la importación finalice, nos mostrará el siguiente mensaje.
5.) En la sección APIs veremos que se agregó una nueva carpeta llamada calculator.
Dentro de la carpeta encontraremos unos servicios de prueba que podemos consumir.
Presionamos Add, luego presionamos Body (raw debe ser XML). En las líneas 5 y 6
podremos ingresar valor a las variables. Presionamos Send para consumir la petición.
6.) En la sección inferior de Response veremos lo que retorna el servicio. En la línea 6
veremos el resultado de la suma.
Pág. 7
[Link]
Material Estudio:
5. Uso de REST API
Las API REST comúnmente tienen servicios de tipo GET, POST, PUT y DELETE. Estos
servicios pueden ser fácilmente identificados ya que el nombre del método que utilizan
se declara antes de cada servicio. A continuación, se mostrarán servicios métodos HTTP:
El consumo de los servicios debe respetar el método HTTP que utilicen o la API rechazará
la petición y tendremos un error HTTP 405.
Pág. 8
[Link]
Material Estudio:
Para realizar el correcto consumo del servicio seleccionamos en Postman (o la
herramienta utilizada) el método HTTP correcto. En este ejemplo es el método POST.
Una vez el consumo fue hecho correctamente, veremos que el servicio responde con el
código HTTP 200 (exitoso), y el cuerpo de la respuesta mostrará el contenido que el
servicio obtuvo.
Pág. 9
[Link]
Material Estudio:
¿Cómo sabemos que método HTTP utilizar para nuestro servicio?
GET
Es utilizado para obtener recursos de una API. Al utilizar este tipo de petición los parámetros del servicio
son visibles en la URL de la petición. Se deben tener las consideraciones de seguridad para no enviar
información sensible en texto pleno. Para mitigar este riesgo pueden encriptarse los parámetros para
protegerlos.
POST
Es utilizado para enviar información a la API, con el propósito de crear algo en nuestro backend. Al
utilizar post, la información va oculta en las cabeceras HTTP y no está visible la URL. De esta manera
hacemos una petición más segura.
PUT
Nos sirve para actualizar recursos de nuestro backend. Cualquier cosa que nos actualice información en
nuestra base de datos utilizaremos este método. En cuanto a la seguridad, la información enviada viaja
de forma segura al igual que POST.
DELETE
Es utilizado para eliminar recursos de nuestro backend. Si este recurso es utilizado múltiples veces
tendrá el mismo efecto que utilizarlo solo una vez.
Pág. 10
[Link]