Aprende a consumir servicios REST vía HTTPS leyendo precios de criptomonedas


Una de las tareas más comunes de un desarrollador es consumir servicios REST vía HTTPS, en este post se explicará lo siguiente:

  • Generar un certificado HTTPS
  • Instalar el certificado en la máquina virtual
  • Crear un cliente REST
  • Hacer una petición para obtener el valor de criptomonedas

Paso 1 Analizar el api a consumir

En este ejemplo leeremos información sobre criptomonedas, para hacerlo utilizaremos el api REST de Bitso (Empresa dedicada a la compra y venta de bitcoins, ripple, litecoin, entre otras criptomonedas). Para más información sobre los endpoints disponibles ver el siguiente link Documentación Bitso. En este ejemplo se consumirá un servicio para obtener el precio del bitcoin y ripple para esto se utilizará el endpoint ticker con los siguientes parámetros:

Es importante mencionar que los precios mostrados en este sitio son en pesos mexicanos.

Paso 2 Configurar el projecto

Una vez que entendemos el api que se va a consumir que conocemos los endpoints que se ejecutarán, el siguiente paso será crear un proyecto, para esto se creará un proyecto Maven e incluiremos las siguientes dependencias:

<dependencies>
	<dependency>
		<groupId>org.apache.storm</groupId>
		<artifactId>storm-core</artifactId>
		<version>1.0.1</version>
	</dependency>
	<dependency>
		<groupId>org.glassfish.jersey.core</groupId>
		<artifactId>jersey-client</artifactId>
		<version>2.17</version>
	</dependency>
	<dependency>
		<groupId>org.glassfish.jersey.media</groupId>
		<artifactId>jersey-media-json-jackson</artifactId>
		<version>2.17</version>
	</dependency>
</dependencies>

Y el siguiente plugin de Maven:

<build>
	<plugins>
		<plugin>
			<artifactId>maven-compiler-plugin</artifactId>
			<version>3.2</version>
			<configuration>
				<source>1.8</source>
				<target>1.8</target>
			</configuration>
		</plugin>
	</plugins>
</build>

Con estas dependencias y este plugin tendremos la versión de Java 8 y las dependencias necesarias para trabajar con Jersey client (El api que se utilizará para consumir servicios).

Paso 3 Creando modelo de la aplicación

Un paso importante al crear un cliente REST es des serializar la respuesta a objetos java, para esto debemos crear una representación del JSON en clases Java.

Json:

{
	success: true,
	payload: {
		high: "15.13",
		last: "14.69",
		created_at: "2017-12-18T14:13:36+00:00",
		book: "xrp_mxn",
		volume: "1700513.79486861",
		vwap: "14.14839779",
		low: "14.07",
		ask: "14.69",
		bid: "14.50"
	}
}

Clases Java:

PayLoad.java


import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * @author raidentrance
 *
 */
public class Payload {

	@JsonProperty("high")
	private double high;

	@JsonProperty("last")
	private double last;

	@JsonProperty("created_at")
	private String createdAt;

	@JsonProperty("book")
	private String book;

	@JsonProperty("volume")
	private Double volume;

	@JsonProperty("vwap")
	private Double vwap;

	@JsonProperty("low")
	private Double low;

	@JsonProperty("ask")
	private Double ask;

	@JsonProperty("bid")
	private Double bid;

	public double getHigh() {
		return high;
	}

	public void setHigh(double high) {
		this.high = high;
	}

	public double getLast() {
		return last;
	}

	public void setLast(double last) {
		this.last = last;
	}

	public String getCreatedAt() {
		return createdAt;
	}

	public void setCreatedAt(String createdAt) {
		this.createdAt = createdAt;
	}

	public String getBook() {
		return book;
	}

	public void setBook(String book) {
		this.book = book;
	}

	public Double getVolume() {
		return volume;
	}

	public void setVolume(Double volume) {
		this.volume = volume;
	}

	public Double getVwap() {
		return vwap;
	}

	public void setVwap(Double vwap) {
		this.vwap = vwap;
	}

	public Double getLow() {
		return low;
	}

	public void setLow(Double low) {
		this.low = low;
	}

	public Double getAsk() {
		return ask;
	}

	public void setAsk(Double ask) {
		this.ask = ask;
	}

	public Double getBid() {
		return bid;
	}

	public void setBid(Double bid) {
		this.bid = bid;
	}

	@Override
	public String toString() {
		return "Payload [high=" + high + ", last=" + last + ", createdAt=" + createdAt + ", book=" + book + ", volume="
				+ volume + ", vwap=" + vwap + ", low=" + low + ", ask=" + ask + ", bid=" + bid + "]";
	}

}

CoinPrice.java


/**
 * @author raidentrance
 *
 */
public class CoinPrice {
	private boolean success;
	private Payload payload;

	public boolean isSuccess() {
		return success;
	}

	public void setSuccess(boolean success) {
		this.success = success;
	}

	public Payload getPayload() {
		return payload;
	}

	public void setPayload(Payload payload) {
		this.payload = payload;
	}

	@Override
	public String toString() {
		return "RipplePrice [success=" + success + ", payload=" + payload + "]";
	}

}

Paso 4 Creando el cliente REST

El siguiente paso es empezar a escribir código, lo primero que escribiremos será un AbstractClient, que servirá para dar soporte para escribir multiples clientes REST:

AbstractClient.java


import java.util.logging.Logger;

import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.WebTarget;

/**
 * @author raidentrance
 *
 */
public class AbstractClient {
	private String url;
	private String contextPath;

	private static final Logger log = Logger.getLogger(AbstractClient.class.getName());

	public AbstractClient(String url, String contextPath) {
		this.url = url;
		this.contextPath = contextPath;
	}

	protected WebTarget createClient(String path) {
		String assembledPath = assembleEndpoint(path);
		Client client = ClientBuilder.newClient();
		WebTarget target = client.target(assembledPath);
		return target;
	}

	private String assembleEndpoint(String path) {
		String endpoint = url.concat(contextPath).concat(path);
		log.info(String.format("Calling endpoint %s", endpoint));
		return endpoint;
	}
}

La clase AbstractClient será la clase base que se utilizará para todos los clientes que creemos, cuenta con dos métodos principales:

  • assembleEndpoint(String path) : Construye la url a ejecutar
  • WebTarget createClient(String path) : Crea el cliente HTTP para invocar la petición REST, en caso de requerir autenticar la petición este es el lugar para hacerlo.

ApplicationEndpoint.java


/**
 * @author raidentrance
 *
 */
public class ApplicationEndpoint {
	private static String TICKER = "/ticker";

	public static String getCoinPrice(String coin) {
		return TICKER.concat(String.format("?book=%s", coin));
	}
}

La clase ApplicationEndpoint se utiliza para definir los endpoints a ejecutar en la aplicación.

ServiceException.java


/**
 * @author raidentrance
 *
 */
public class ServiceException extends Exception {
	private Integer httpStatusCode;

	private static final long serialVersionUID = -1873750263916403862L;

	public ServiceException(String message, Integer httpStatusCode) {
		super(message);
		this.httpStatusCode = httpStatusCode;
	}

	public Integer getHttpStatusCode() {
		return httpStatusCode;
	}

	public void setHttpStatusCode(Integer httpStatusCode) {
		this.httpStatusCode = httpStatusCode;
	}
}

La clase ServiceException se utilizará para propagar los errores en caso de que existan.
BitsoClient


import java.util.logging.Logger;

import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;

import com.raidentrance.client.endpoints.ApplicationEndpoint;
import com.raidentrance.client.error.ServiceException;
import com.raidentrance.client.model.CoinPrice;

/**
 * @author raidentrance
 *
 */
public class BitsoClient extends AbstractClient {
	private static final Logger log = Logger.getLogger(BitsoClient.class.getName());

	public BitsoClient(String url, String contextPath) {
		super(url, contextPath);
	}

	public CoinPrice getRipplePrice() throws ServiceException {
		log.info("Getting ripple price");
		WebTarget client = createClient(ApplicationEndpoint.getCoinPrice("xrp_mxn"));
		Response response = client.request(MediaType.APPLICATION_JSON).get();
		log.info("Status " + response.getStatus());
		CoinPrice result = null;
		Integer status = response.getStatus();
		if (Status.OK.getStatusCode() == status) {
			result = response.readEntity(CoinPrice.class);
		} else {
			throw new ServiceException(response.readEntity(String.class), status);
		}
		return result;
	}

	public CoinPrice getBitcoinPrice() throws ServiceException {
		log.info("Getting ripple price");
		WebTarget client = createClient(ApplicationEndpoint.getCoinPrice("btc_mxn"));
		Response response = client.request(MediaType.APPLICATION_JSON).get();
		log.info("Status " + response.getStatus());
		CoinPrice result = null;
		Integer status = response.getStatus();
		if (Status.OK.getStatusCode() == status) {
			result = response.readEntity(CoinPrice.class);
		} else {
			throw new ServiceException(response.readEntity(String.class), status);
		}
		return result;
	}

}

Ahora es tiempo de crear el cliente REST en este caso será la clase BitsoClient como se puede ver recibe los siguientes parámetros en el constructor:

  • url : Representa la url a consumir
  • contextPath : Representa la url base de los servicios

También cuenta con 2 métodos:

  • getRipplePrice() : Como su nombre lo indica devuelve un objeto con el precio actual de la criptomoneda ripple.
  • getBitcoinPrice() : Como su nombre lo indica devuelve un objeto con el precio actual de la criptomoneda bitcoin.

TestClient.java


import com.raidentrance.client.error.ServiceException;
import com.raidentrance.client.model.CoinPrice;

/**
 * @author raidentrance
 *
 */
public class TestClient {
	public static void main(String[] args) throws ServiceException {
		BitsoClient client = new BitsoClient("https://api.bitso.com/", "v3");
		CoinPrice ripplePrice = client.getRipplePrice();
		CoinPrice bitcoin = client.getBitcoinPrice();
		System.out.println(String.format("Ripple price %s",ripplePrice.toString()));
		System.out.println(String.format("Bitcoin price %s",bitcoin.toString()));
	}
}

La clase TestClient se utilizará para mostrar en consola los valores obtenidos por las API’s REST.

Ejecutando la aplicación

Si ejecutamos la aplicación y no contamos con el certificado para ejecutar la petición recibiremos el siguiente error:

SunCertPathBuilderException: unable to find valid certification path to requested target

Así que utilizaremos una clase llamada InstallCert.java creada por el equipo de sun que puedes encontrar aquí, ejecutarla pasando como parámetro la url de la cual deseas extraer el certificado con el siguiente comando :

java InstallCert api.bitso.com

El cuál mostrará la siguiente salida:

Opening connection to api.bitso.com:443...
Starting SSL handshake...

No errors, certificate is already trusted

Server sent 3 certificate(s):

 1 Subject CN=ssl511101.cloudflaressl.com, OU=PositiveSSL Multi-Domain, OU=Domain Control Validated
   Issuer  CN=COMODO ECC Domain Validation Secure Server CA 2, O=COMODO CA Limited, L=Salford, ST=Greater Manchester, C=GB
   sha1    11 bd 1f 03 0a b4 07 8c d3 f1 49 16 f2 97 0a 9f 97 07 55 cd
   md5     33 1e 1d 7f 95 09 de 0b 0b b8 31 9d f2 48 85 b8

 2 Subject CN=COMODO ECC Domain Validation Secure Server CA 2, O=COMODO CA Limited, L=Salford, ST=Greater Manchester, C=GB
   Issuer  CN=COMODO ECC Certification Authority, O=COMODO CA Limited, L=Salford, ST=Greater Manchester, C=GB
   sha1    75 cf d9 bc 5c ef a1 04 ec c1 08 2d 77 e6 33 92 cc ba 52 91
   md5     5e 0e 41 9b 20 ea 57 54 77 f1 1b 52 e2 c8 18 e0

 3 Subject CN=COMODO ECC Certification Authority, O=COMODO CA Limited, L=Salford, ST=Greater Manchester, C=GB
   Issuer  CN=AddTrust External CA Root, OU=AddTrust External TTP Network, O=AddTrust AB, C=SE
   sha1    ae 22 3c bf 20 19 1b 40 d7 ff b4 ea 57 01 b6 5f dc 68 a1 ca
   md5     c7 90 a5 6c 69 cb af 0b f3 f3 0a 40 d0 a2 ae cc

<strong>Enter certificate to add to trusted keystore or 'q' to quit: [1]</strong>

Oprimiremos la tecla de 1 y enter.

Ejecutaremos de nuevo el comando, seleccionaremos 1 de nuevo y notaremos que la salida es ahora la siguiente:

Added certificate to keystore 'jssecacerts' using alias 'api.bitso.com-1'

Este comando generará un archivo llamado jssecacerts, el último paso será copiar ese archivo al directorio $JAVA_HOME\jre\lib\security y listo, tu aplicación podrá hacer peticiones https a el dominio de bitso.

El último paso será ejecutar nuestra aplicación para validar que todo funciona bien y generará la siguiente salida:

dic 18, 2017 10:37:04 AM com.raidentrance.client.BitsoClient getRipplePrice
INFORMACIÓN: Getting ripple price
dic 18, 2017 10:37:04 AM com.raidentrance.client.AbstractClient assembleEndpoint
INFORMACIÓN: Calling endpoint https://api.bitso.com/v3/ticker?book=xrp_mxn
dic 18, 2017 10:37:05 AM com.raidentrance.client.BitsoClient getRipplePrice
INFORMACIÓN: Status 200
dic 18, 2017 10:37:05 AM com.raidentrance.client.BitsoClient getBitcoinPrice
INFORMACIÓN: Getting ripple price
dic 18, 2017 10:37:05 AM com.raidentrance.client.AbstractClient assembleEndpoint
INFORMACIÓN: Calling endpoint https://api.bitso.com/v3/ticker?book=btc_mxn
dic 18, 2017 10:37:06 AM com.raidentrance.client.BitsoClient getBitcoinPrice
INFORMACIÓN: Status 200
<strong>Ripple price RipplePrice [success=true, payload=Payload [high=15.13, last=14.67, createdAt=2017-12-18T16:37:02+00:00, book=xrp_mxn, volume=1908408.5657127, vwap=14.20595744, low=14.07, ask=14.64, bid=14.52]]
Bitcoin price RipplePrice [success=true, payload=Payload [high=382000.0, last=374994.16, createdAt=2017-12-18T16:37:03+00:00, book=btc_mxn, volume=301.0574943, vwap=373301.92134721, low=362505.0, ask=375800.0, bid=374994.16]]</strong>

Como se puede ver se imprimieron los precios de las criptomonedas de forma exitosa, ya dependerá de ti la aplicación que crees con esto.

Conclusión

En este post se tocaron temas importantes como:

  • Configurar un proyecto para hacer peticiones REST con Jersey
  • Crear un patrón de diseño para la construcción de clientes REST
  • Ejecutar peticiones REST vía HTTPS
  • Obtener el valor en pesos de las criptomonedas Bitcoin y Ripple

Si te gusta el contenido y quieres enterarte cuando realicemos un post nuevo síguenos en nuestras redes sociales https://twitter.com/geeks_mx y https://www.facebook.com/geeksJavaMexico/.

Autor: Alejandro Agapito Bautista

Twitter: @raidentrance

Contacto:raidentrance@gmail.com

Anuncios

Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión /  Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión /  Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión /  Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión /  Cambiar )

w

Conectando a %s