Consumo de APIs con PHP y manejo de peticiones HTTP

Clase 5 de 19 • Curso de API REST con PHP

Resumen

Utilizando el comando ‘curl’ dentro de nuestra terminal podemos realizar peticiones a cualquier sitio web, por ejemplo una API como la de xkcd.

curl https://xkcd.com/info.0.json

El anterior comando nos regresa información del API, pero de manera poco legible. para poder verlo de manera más ordenada podemos usar el siguiente comando:

curl https://xkcd.com/info.0.json | jq

Óscar Castañeda

student•

Me estresa mucho ver el código en php.

Les dejo unas instrucciones si quieren usar Javascript

En una carpeta vacia ejecuta en terminal npm init --yes
Ejecuta npm i axios
En un archivo llamado index.js copia el siguiente código

const axios = require('axios')

const url = 'https://xkcd.com/info.0.json'

axios.get(url)
  .then(res => console.log(res.data))
  .catch(err => console.log(err))

Respuesta:

{
  "month": "12",
  "num": 2238,
  "link": "",
  "year": "2019",
  "news": "",
  "safe_title": "Flu Shot",
  "transcript": "",
  "alt": "\"Wait, how often are you getting bitten by snakes? And why are you boiling water?\" \"Dunno, the CDC people keep showing up with complicated questions about the 'history of the property' and 'possible curses' but I kinda tune them out. At least one of them offered me the flu shot.\"",
  "img": "https://imgs.xkcd.com/comics/flu_shot.png",
  "title": "Flu Shot",
  "day": "6"
}

David Santiago González Ramos

student•

x2 Prefiero JS toda la vida✌

Gustavo Hernan Tiseira

student•

Gracias me sirvió mucho. Quisiera aprendar mas sobre el paquete axios. Se ve muy interesante

Omar Perez

student•

Ejemplo implementado en python

from urllib.request import urlopen
import json

base_url = "https://xkcd.com/info.0.json"

# To convert bytes in text
data = urlopen(base_url).read().decode('UTF-8')

# json.loads to decode in text
data_json_obj = json.loads(data)

print(data_json_obj["img"])

HERNAN DARIO VELASQUEZ ORTIZ

student•

Realice una pequeña modificación a su código para usar la libreria requests, en vez de urllib.

import requests
import json

base_url = "https://xkcd.com/info.0.json"

# To convert bytes in text
data = requests.get(base_url)

# json.loads to decode in text
data_json_obj = json.loads(data.text)

print('\n',data_json_obj["img"],'\n')

Jefferson Steven Montilla Mendoza

student•

Mismo ejemplo con la librería requests:

import requests

response = requests.get('https://xkcd.com/info.0.json')

if response.status_code == 200:
    print(response.json())

Luis Rodrigo Vazquez Palacios

student•

Es interesante aprender a utilizar la herramienta aunque hay otras como postman que es mas sencillo.

Angie Leyton Castro

student•

También hay otra llamada Fiddler, pero postman es más facíl para mi ;)

Elmer Padilla Espinoza

student•

Muy buenos comentarios, el fin de estos cursos es desplegar el abanico de opciones que mejor nos resulte, me parece bien que todos podamos llegar ha conclusiones similares con el mismo origen.

José Daniel Calle Briceño

student•

Para usar jq instalémoslo mediante sudo apt-get update sudo apt-get install jq

Facundo Vergara

student•

idolo!

Cristhiam Daniel Campos Julca

student•

Crack!

Jair Israel Avilés Eusebio

student•

Una alternativa a cUrl es HTTPie el cual como valor agregado es sencillo de user, muestra los headers de la respuesta y ya aplica formato a la respuesta como lo hace jq sin necesidad de instalar un modulo adicional. Recomendada al 100% pues es muy usada en la industria.

Jonathan Jiménez Soveranes

student•

Cierto, en realidad la info se muestra mejor, gracias!

Fabian Steven Marin Guerrero

student•

Gracias por el aporte esta genial!

fabianmarin@Fabians-MacBook-Pro ~ % http  https://xkcd.com/info.0.json 
HTTP/1.1 200 OK
Accept-Ranges: bytes
Age: 0
Cache-Control: max-age=300
Connection: keep-alive
Content-Encoding: gzip
Content-Length: 230
Content-Type: application/json
Date: Fri, 23 Apr 2021 07:54:28 GMT
ETag: W/"60824641-145"
Expires: Fri, 23 Apr 2021 04:45:33 GMT
Last-Modified: Fri, 23 Apr 2021 04:00:01 GMT
Server: nginx
Vary: Accept-Encoding
Via: 1.1 varnish
X-Cache: MISS
X-Cache-Hits: 0
X-Served-By: cache-bog6429-BOG
X-Timer: S1619164468.801251,VS0,VE387

{
    "alt": "Extremely rude how Turing's later formulations of the halting problem called me out by name specifically.",
    "day": "21",
    "img": "https://imgs.xkcd.com/comics/excel_lambda.png",
    "link": "",
    "month": "4",
    "news": "",
    "num": 2453,
    "safe_title": "Excel Lambda",
    "title": "Excel Lambda",
    "transcript": "",
    "year": "2021"
}

Christian David Sánchez

student•

Utilicen postman para realizar peticiones https://www.getpostman.com/products

Luis Alejandro Vera Hernandez

student•

Buena idea

freddy molleda

student•

En python tambien se puede realizar las mismas peticionoes get y post a un servidor que las acepte usando la libreria requests . por ejemplo hay un página que tiene un api que nos permite realizarles peticiones con todos los verbos http (http:/httpbin.org) . un ejemplo de esta página con un código python sería:

from requests import get, post

if __name__ == "__main__":

    url = "http://httpbin.org/get"

    data = {
        "nombre":"tu_nombre",
        "apellido":"tu_apellido"
    } 

    response = get(url)
    
    #respuesta del servidor a la peticion get
    print("contenido de la respuesta del servidor:\n")
    print(response.text)
    
    #trabajar con la respuesta json del servidor
    json_response = response.json()
    print("valor de la llave origin")
    print(json_response['origin'])

    #usar metodo post y enviarle parametros dentro de los headers
    url = "http://httpbin.org/post"
    response = post(url, headers=data)

    #respuesta del servidor donde vemos en donde se envian los datos enviados con el metodo post
    print(response.text)

Cinthya Cabanzo

student•

Para usar el comando jq en

curl https://xkcd.com/info.0.json | jq

Es necesario que instales jq

https://stedolan.github.io/jq/download/

Omar Perez

student•

Gracias :)

Omar Perez

student•

Gracias :)

Camilo Ramirez Castillo

student•

Para instalar php en ubuntu se debe ingresar el siguiente comando:

sudo apt-get install php

y para verificar la version instalada:

php -v

Carlos Eduardo Carvajal Montealegre

student•

Al día de hoy el comando que me funcionó es: sudo apt install php7.4-cli Pero antes se le realizo los comandos: sudo apt update sudo apt upgrade

Gerald Zamora

student•

En java:

public class Main {
    public static void main(String[] args) {
			 Unirest.setTimeouts(0, 0);
        try {
            HttpResponse<String> stringHttpResponse = Unirest.get("https://xkcd.com/info.0.json").asString();
            System.out.println(stringHttpResponse.getBody());
        } catch (UnirestException e) {
            e.printStackTrace();
        }
	}
}

dependencias maven:

			<dependency>
            <groupId>com.mashape.unirest</groupId>
            <artifactId>unirest-java</artifactId>
            <version>1.4.9</version>
        </dependency>

Cristhian Franco

student•

Muchas gracias :D

Francisco Enrique Giménez Vera

student•

Este curso debería llamarse API REST con PHP

Jean Michael Lozano Cardoso

student•

Ya le pusieron ese nombre jajaja

Oscar Saucedo

student•

Ejemplo en Go

package main

//version of get using Golang - Platzi (API REST course)

import (
	"encoding/json"
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
	"time"
)

func main() {
	url := "https://xkcd.com/info.0.json"
	client := http.Client{
		Timeout: time.Second * 2, // Maximum of 2 secs
	}
	req, err := http.NewRequest(http.MethodGet, url, nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("User-Agent", "spacecount-tutorial")

	res, getErr := client.Do(req)
	if getErr != nil {
		log.Fatal(getErr)
	}
	body, readErr := ioutil.ReadAll(res.Body)
	if readErr != nil {
		log.Fatal(readErr)
	}
	obj := make(map[string]interface{})
	jsonErr := json.Unmarshal(body, &obj)
	if jsonErr != nil {
		log.Fatal(jsonErr)
	}

	//jsonData := string(body)
	fmt.Println(obj["img"])
}

Iraida Mercedes Barreto Díaz

student•

Yo lo hice con python:

import urllib.request
import json

def main():
        url = 'https://xkcd.com/info.0.json'
        response = urllib.request.urlopen(url)
        data = json.loads(response.read())
        print (json.dumps(data, sort_keys=True))

if __name__ == &quot;__main__&quot;:    main()

python3 xkcd.py | jq

Respuesta:

{
  &quot;alt&quot;: &quot;So excited to see everyone after my luxury cruise home from the World Handshake Championships!&quot;,
  &quot;day&quot;: &quot;23&quot;,
  &quot;img&quot;: &quot;https://imgs.xkcd.com/comics/sabotage.png&quot;,
  &quot;link&quot;: &quot;&quot;,
  &quot;month&quot;: &quot;3&quot;,
  &quot;news&quot;: &quot;&quot;,
  &quot;num&quot;: 2284,
  &quot;safe_title&quot;: &quot;Sabotage&quot;,
  &quot;title&quot;: &quot;Sabotage&quot;,
  &quot;transcript&quot;: &quot;&quot;,
  &quot;year&quot;: &quot;2020&quot;
}

Daniel Alejandro Cumaco Robayo

student•

Reinventas la rueda, mal eso :p

Perfectamente puedes crear este codigo bash

curl -s &quot;$1&quot; | jq &quot;$2&quot; | xargs curl -s --remote-name

y ejecutarlo desde python, el performance es bastante importante en python

import subprocess as sp
sp.call([&quot;./code.sh&quot;, &quot;https://xkcd.com/info.0.json&quot;, &quot;.img&quot;])

Ahi puedes jugar con iteradores para hacerlo a gran escala, eso permite tambien que tu codigo sea escalable

Royer Guerrero Pinilla

student•

Esta es otra forma un poco mas sencilla, necesitas instalar request

import requests

r = requests.get('https://xkcd.com/info.0.json')
print(r.json())

Javier Eduardo

student•

Para verlo en el navegador pueden usar la extensión JSON Viewer de chrome

Marco Antonio González Arellano

student•

De las muchas herramientas que existen me gusta la extensión de VS Code, HTTP Client.

![](

Carlos Eduardo Gomez García

teacher•

Genial, me gusta PHP, pero el tema de las cURL's en PHP es muy... no es bonito a la vista, yo cree una función PHPque se parece a axios de JavaScript, si seguimos usando cURL's con PHP la paso xD

Carlos Andres Castañeda Osorio

student•

Siempre es bueno conocer la documentación, en este caso de curl_init en PHP

Brayan Stiven Marin

student•

Ejemplo en Ruby

require 'httpclient'

client = HTTPClient.new

puts client.get_content "https://xkcd.com/info.0.json"

Juan Pablo Lagos Idrobo

student•

Muchas gracias, creo que voy a aplicar este ya que estoy siguiendo este curso porque esta en la ruta de aprendizaje de Ruby on Rails

Juan Diego Silva Garcia

student•

Pueden instalar la extención JSONView y ver el JSON más amigable y poder interactuar con el.

Mariano Gastón Paduani

student•

JSON Formatter es otra opción

Royer Guerrero Pinilla

student•

No olviden instalar jp antes de usarlo

sudo apt-get install jq

Consumo de APIs con PHP y manejo de peticiones HTTP

Comprender los objetivos y pre-requisitos del curso

Integración de Aplicaciones Web con PHP

Concepto y Herramientas Básicas de API en Programación

Conocer los conceptos principales de REST

Conceptos Básicos de HTTP y su Funcionamiento en Navegadores

Protocolo REST: Conceptos y Funciones Básicas

Aprender a consumir servicios REST

Consumo de APIs con PHP y manejo de peticiones HTTP

Aprender a producir servicios REST

Creación de un Servidor REST con PHP

Consulta de recursos específicos en PHP y URLs amigables

Incorporación de Datos a Servidor mediante API REST en PHP

Modificación de recursos en servidor con método HTTPS Push

Eliminar recursos con método DELETE en APIs RESTful

Conocer diferentes modos de restringir el acceso a las API Rest

Autenticación Básica HTTP en PHP: Implementación y Limitaciones

Autenticación Segura con Hashes y Clave Secreta en PHP

Autenticación con Access Touch: Implementación y Funcionamiento

Aprender a tratar errores en la comunicación vía REST

Manejo de Errores HTTP en Cliente y Servidor con PHP

Aprender a utilizar una API Rest para la comunicación FrontEnd/BackEnd

Comunicación Asíncrona en Aplicaciones de una Sola Página

JavaScript para Interacción con el DOM y AJAX

Comunicación con el Servidor Usando AJAX y JSON en JavaScript

Publicación y Configuración de Aplicaciones en Servidores Públicos

Conocer buenas prácticas del diseño de APIs REST

Buenas prácticas para diseñar APIs RESTful