Conéctese a API sin código: 8 pasos

2024 Autor: John Day | [email protected]. Última modificación: 2024-01-30 08:40

Esta guía está diseñada para personas que desean lograr algo que requiera el uso de una API, pero que no están muy seguras de cómo comenzar. Ya sabe por qué es útil poder trabajar con una API y esta guía le mostrará cómo hacerlo.

Si eso te suena, ¡estás de suerte! Estamos aquí para explicar cómo trabajar con API, cómo leer documentos de API y cómo usar realmente los datos provenientes de una API.

Hemos traído a un amigo para hacer el viaje mucho más fácil.

Conoce a Slash

Slash es el adorable y adorable perro de Michelle (en la foto de arriba). Michelle es una ingeniera de software que crea API. Michelle disfruta mucho de su trabajo y se ha inspirado en su trabajo en la creación de API en la formación de Slash.

Como sabrá, una API es una colección de comandos que un usuario puede dar a un servicio web junto con un conjunto de respuestas que coinciden con la solicitud. Michelle ha entrenado a Slash para que haga exactamente lo mismo. Slash es un buen chico, conoce una variedad de comandos y siempre responde correctamente siempre que le des una petición que le han enseñado. Cuando se emociona más, su cola se vuelve loca; esto no es algo que Michelle le enseñó en relación con las API, ¡es solo porque es un cachorro adorable y realmente disfruta de su entrenamiento!

Paso 1: decida qué API necesita

¿Qué información busca o desea cambiar?

¿Estás tratando de capturar todas las publicaciones de Instagram de @ dougthepug? Tal vez quieras tuitear automáticamente a cualquiera que siga el twitter de tu perro (porque aunque los perros no pueden hablar, tienen mucho que decir, sabemos que Slash sí lo hace).

Si ya conoce el sitio o la API a la que está intentando conectarse, vaya directamente al Paso 2. Si está intentando buscar datos, pero no está seguro de por dónde empezar, Google es su amigo. Busque "[cosas que le interesan] API" y vea lo que aparece. Es posible que se sorprenda de la cantidad de información disponible.

Si desea una API de ejemplo simple, puede usar la que hizo Michelle mientras entrenaba a Slash. Tiene algunos de sus comandos favoritos, como recuperar bolas y cavar agujeros. Lo usaremos en el resto de nuestros ejemplos.

Paso 2: busque los documentos de la API

Las API proporcionadas por empresas reconocidas deben tener documentación completa sobre cómo utilizarlas.

Para encontrarlos, busque en Google "Documentación de la API de [Insertar empresa]" o "Desarrollador de [Insertar empresa]".

Los resultados deberían llevarlo al portal para desarrolladores. Busque un enlace que diga "Documentos", "Documentación", "Referencia" o "Referencia técnica".

Dentro de los documentos, es posible que deba buscar la API específica que desea, ya que a veces puede haber muchas opciones. Facebook, por ejemplo, tiene API independientes para marketing, anuncios, páginas y más.

Si la API a la que desea conectarse no es muy conocida (como la de Slash), es posible que deba pedirle documentación al desarrollador. Es posible que tengan un PDF que contenga la información que necesita o documentación en línea que no figura en su sitio web.

Si se perdió el enlace en el paso anterior, los documentos de la API de Slash se pueden encontrar aquí.

Paso 3: encontrar el punto final

Los documentos API pueden parecer desalentadores, pero una vez que sepa qué buscar, generalmente están bien estructurados y bastante estandarizados.

Lo primero que debe buscar son los puntos finales apropiados. Debe haber un punto final correspondiente a cada tipo de datos que desee. Un punto final podría verse así:

slashtheapidog.com/api/bones/{id}

o solo

/huesos

La documentación debe tener una lista de puntos finales. Pueden ser de nivel superior en los documentos o en una sección llamada "referencia", "puntos finales" o "métodos". Para encontrar el punto final correcto, busque el nombre que corresponda con los datos que está buscando. Por ejemplo, si desea una lista de todos los agujeros que Slash ha cavado, probablemente / holes sea el correcto. En cualquier caso, cada punto final debe tener una descripción que ayude a explicar lo que hace.

De sus documentos, estos son los puntos finales en la API de Slash relacionados con los agujeros:

OBTENER

OBTENGA

PUBLICAR

PONER

PUBLICAR

Paso 4: Determine su tipo de solicitud

Ahora que ha encontrado el punto final correcto, debe determinar el tipo de solicitud para enviarlo.

Hay 4 tipos diferentes de solicitudes:

OBTENER

Una solicitud GET es la forma en que le pide a la API que responda con algo que tiene, la mayoría de las veces datos. Puede solicitar información específica sobre un elemento o un grupo de elementos según el punto final y los parámetros. Esto es el equivalente a pedirle a Slash que le traiga uno de sus huesos o todos sus huesos.

CORREO

Una solicitud POST es cómo le dices a la API que cree algo nuevo. Esto es similar a pedirle a Slash que excave (cree) un nuevo agujero para usted.

PONER

Una solicitud PUT es cómo le dices a la API que actualice algo que se creó anteriormente. Esto es similar a pedirle a Slash que profundice (actualice) el hoyo que cavó.

ELIMINAR

Una solicitud DELETE es cómo le dice a la API que elimine algo que se creó anteriormente. Esto es similar a pedirle a Slash que cubra (elimine) un agujero que cavó anteriormente.

Piense en estos cuatro tipos. ¿Está obteniendo información, creando una nueva entrada, cambiando una entrada existente o eliminando una? Esa respuesta le dice exactamente qué tipo de solicitud necesita.

Paso 5: comprender los parámetros

Muchas solicitudes requieren parámetros adicionales. Los parámetros son los detalles de su solicitud. Por ejemplo, si desea que Slash le traiga todas las bolas que son rojas, debe especificar el color. Si desea que cree un nuevo agujero, debe decirle dónde colocarlo y qué tan profundo cavar.

La documentación de la API a la que hace referencia debe tener una sección llamada "Parámetros" u "Opciones" para cada punto final y tipo de solicitud. Preste atención a los parámetros que se requieren, ya que algunos son opcionales. Si un parámetro está marcado como opcional, los documentos pueden proporcionar un ejemplo que también es el predeterminado.

Los parámetros de la API de Slash pueden verse así para recuperar bolas:

OBTENER

Paso 6: formatee su solicitud

Tenemos toda la información que necesitamos, ¡ahora solo necesitamos hacer la solicitud!

Aquí hay dos formas diferentes de conectarse a una API que no requieren código. Conéctese a la API de Slash para obtener su lista de bolas haciendo una solicitud GET a

Parábola: si desea conectarse y trabajar con datos sin código

Parabola es una aplicación web que le permite conectarse fácilmente a las API y luego trabajar con los datos a través de una herramienta visual de arrastrar y soltar.