¿Qué es un punto final de API? (¿Y por qué son tan importantes?)

Las API proporcionan los datos necesarios para brindar soluciones a los problemas de los clientes. Para mantenerse al día con la competencia, debe comprender qué son las API, cómo funcionan con su estrategia de contenido y qué características aportan las API y los puntos finales de API a su sitio web o producto.

API, abreviatura de Interfaz de programación de aplicaciones, es una serie de reglas que permiten que una aplicación comparta sus datos con desarrolladores externos. En pocas palabras, la API le permite tomar «sus cosas» y hacer que funcione con «sus cosas». Sus cosas, en este caso, están en Punto final de la API.

En esta guía, repasaremos qué es un punto final de API, qué papel juegan los puntos finales en las integraciones y cómo comenzar a probarlos con API públicas (y potencialmente las suyas propias).

Para comprender completamente esta definición y dónde encajan los puntos finales en el modelo de API, echemos un breve vistazo a cómo funcionan las API.

Para integrar dos aplicaciones a través de Internet, una aplicación, llamada cliente, envía una solicitud a la API de la otra aplicación. El cliente puede solicitar un recurso de la base de datos de la aplicación o solicitar que se realice una acción en el servidor.

Después de recibir y aprobar la solicitud del cliente, la API realiza la acción solicitada y luego envía la respuesta al cliente. Esta respuesta incluye el estado de la solicitud (como Completada o Denegada) y cualquier recurso requerido por el cliente.

Las API generalmente permiten el acceso a una amplia variedad de recursos en el servidor. Por ejemplo, la API de redes sociales puede permitir que los clientes descarguen y modifiquen el contenido de las publicaciones, los perfiles de usuario y las imágenes. La API del sitio de noticias le permitirá acceder al contenido de artículos, autores y medios, como podcasts y videos.

Sabiendo esto, ¿cómo determinan los clientes a qué recurso quieren acceder en su solicitud?

La respuesta es mediante el uso del punto final correcto. En sus solicitudes, los clientes especifican el punto final como una URL. Esta URL le dice al servidor: «El recurso solicitado está en esta ubicación».

El proceso es similar a acceder a sitios web en un navegador. Los navegadores web cargan páginas web enviando la URL al servidor web y el servidor responde con la página solicitada. Asimismo, el cliente necesita una URL de punto final adecuada para solicitar un recurso específico de la API.

Punto final y API

Tenga en cuenta que los puntos finales y las API son diferentes. Un punto final es un componente de API, mientras que una API es un conjunto de reglas que permiten que dos aplicaciones compartan recursos. Los puntos finales son ubicaciones de recursos, y la API usa direcciones URL de puntos finales para recuperar los recursos solicitados.

Ejemplos de puntos finales de API

Los desarrolladores enumeran todos sus puntos finales de API en la documentación para que los usuarios sepan cómo acceder a los recursos que necesitan. Pero, ¿cómo se ven estos puntos finales en la práctica? Veamos algunos ejemplos del mundo real de plataformas líderes.

Un ejemplo de un punto final de la API de Twitter

La API de Twitter proporciona datos sobre tweets, mensajes directos, usuarios y más.

Suponga que desea descargar el contenido de un tweet específico. Para hacer esto, puedes usar punto final de búsqueda de tweetsque tiene una url https://api.twitter.com/2/tweets/[id}(dónde {IDENTIFICACIÓN} es el identificador único del tweet).

Ahora suponga que desea que su sitio transmita tweets públicos en tiempo real para que los visitantes estén informados sobre un tema específico. puedes usar twitter el punto final filtrado de la transmisióncuya URL es https://api.twitter.com/2/tweets/search/stream.

Más adelante en esta publicación, veremos el punto final de la secuencia filtrada con más detalle.

Un ejemplo de un punto final de la API de Spotify

API de Spotify da a los desarrolladores acceso a canciones, artistas, listas de reproducción y datos de usuario. Por ejemplo, si quieres obtener un álbum específicopuede acceder a cualquier álbum en el directorio de Spotify con el punto final https://api.spotify.com/v1/albums/[id} (dónde {IDENTIFICACIÓN} es el identificador único del álbum).

O diga que desea enviar una solicitud que hace que el usuario vea la lista de reproducción. En este caso, envíe una solicitud PUT con el punto final https://api.spotify.com/v1/playlists/arańplaylist_idarzenia/followers (dónde {lista_de_reproducción} es el identificador único de la lista de reproducción).

Ejemplo de punto final de la API de YouTube

La API de YouTube facilita la inserción de videos de YouTube en cualquier sitio web, entre otras cosas. Cuando va a un video de YouTube y copia el código de inserción, solicita el video de la API de YouTube.

Otra forma de obtener videos a través de la API de YouTube es solicitarlos desde un punto final https://www.googleapis.com/youtube/v3/videosque devuelve una lista de películas que coinciden con los parámetros especificados en la solicitud.

¿Por qué son importantes los puntos finales de la API?

Una de las primeras preguntas que hace sobre las API es: ¿Por qué tantas empresas comparten sus datos abiertamente, de forma gratuita?

La mayoría de las veces la respuesta es la escala. A medida que la empresa crece, los empleados de estas empresas se dan cuenta de que tienen más ideas que tiempo y recursos para desarrollarlas. Por lo general, es más fácil colaborar con otras empresas de terceros que se especializan en estas ideas que desarrollarlas internamente.

Al crear API, la empresa permite a los desarrolladores externos crear aplicaciones que mejoran la adopción y el uso de su plataforma. De esta manera, una empresa puede construir un ecosistema que se vuelve dependiente de los datos de su API, lo que a menudo genera oportunidades de ingresos adicionales.

Tomar API de HubSpot como otro ejemplo: al compartir la funcionalidad y los datos de nuestro software a través de las API, los desarrolladores pueden integrar sus aplicaciones con nuestra tecnología, lo que resulta en ecosistema de aplicaciones lo que aumenta nuestro alcance y facilita mucho el trabajo de los clientes que quieren usar otras aplicaciones además de HubSpot.

Como aprendimos, los puntos finales son literalmente críticos para las API. Son el punto donde el cliente y el servidor se comunican. Sin puntos finales correctamente estructurados y en funcionamiento, la API será confusa en el mejor de los casos y rota en el peor. A medida que se ponen a disposición más datos a través de la API, es importante que cada punto final proporcione recursos valiosos para los clientes.

Cómo probar puntos finales de API

Cuando hablamos de las API web, generalmente hablamos de un tipo de API llamado API REST que utiliza métodos HTTP que le indican a la API qué acción tomar. Los cuatro métodos HTTP más populares en las solicitudes de API son:

• OBTENER: obtiene el recurso
• OFICINA DE CORREOS: crea un recurso
• PONER: Actualiza un recurso existente
• ELIMINAR: elimina un activo

Veamos cómo hacer una solicitud usando la API de Twitter el punto final filtrado de la transmisión. Las solicitudes se formatean escribiendo un método HTTP seguido de la URL del punto final. Por lo tanto, la solicitud al extremo del flujo filtrado se vería así: PUBLICAR https://api.twitter.com/2/tweets/search/stream.

Ahora imagina que quieres estar informado sobre HubSpot en Twitter. Querrás recibir tweets de @Cuenta de HubSpot inmediatamente después de su publicación. Además, suponga que solo desea tweets que enlacen a sus artículos.

En ese caso, el uso de un extremo de flujo filtrado es la elección perfecta. Sin embargo, para que la API sepa qué tweets enviarle, debe definir criterios de filtrado. De lo contrario, solo pedirá ver cada tweet publicado en tiempo real (esófago).

Podemos aplicar los criterios de filtro al punto final como reglas. Para crear estas reglas, utilizará un conjunto de operadores. En este ejemplo, puede usar dos operadores API de Twitter: Con: y tiene: enlaces – para ver solo tweets de ciertas cuentas que contienen enlaces. Para indicarle al punto final de flujo filtrado que solo muestre los tweets de las cuentas de @HubSpot que contienen enlaces, use la siguiente regla: de: HubSpot tiene: enlaces.

Utilizará el método HTTP en su solicitud OFICINA DE CORREOS. Además de incluir la regla mencionada anteriormente en su solicitud, proporcionará el tipo de contenido y la autorización. A continuación, el tipo de contenido se define como «aplicación / json», por lo que la solicitud se procesa en formato de datos de notación de objetos JavaScript (JSON).

Hay varias herramientas en línea disponibles para las pruebas de puntos finales de API. Aquí usaremos rizo, una utilidad de línea de comandos HTTP. Puede enviar solicitudes, recuperar datos y enviar datos, lo que lo convierte en una excelente herramienta para probar las API.

Este es el aspecto que debería tener su solicitud a la API de Twitter en la línea de comandos. Debe reemplazar el texto del marcador de posición para autenticar su solicitud $ PORTADOR_FICHA con el token de portador único de su aplicación, que está disponible en su portal para desarrolladores.

 
curl -X POST 'https://api.twitter.com/2/tweets/search/stream/rules' 
-H "Content-type: application/json" 
-H "Authorization: Bearer $BEARER_TOKEN" -d 
'{
"add": [
{"value": "from:HubSpot has:links"}
]
}'

El futuro de las API en los negocios

Vivimos en un mundo que ahora espera que el contenido sea abierto y accesible para todos; la progresión natural de esto es que los editores están lanzando sus propias API para que los clientes puedan desarrollar aplicaciones con ellos.

El uso compartido de API se aplica a todas las empresas: no solo a las que operan en la web, sino a cualquiera que tenga una herramienta web o un componente de su organización. Por supuesto, este concepto creará dificultades para algunas organizaciones, la más importante de las cuales es que todos sepan cómo funcionan las API.

Es fácil quedarse atascado en la jerga técnica de la API. Sin embargo, cuando se usa en casos de la vida real, es más fácil entender cómo funcionan las API de la forma en que lo hacen. Esperamos que ahora tenga una mejor comprensión de uno de sus elementos clave, que son los puntos finales.

Nota del editor: esta publicación se publicó originalmente en septiembre de 2021 y se actualizó para que esté completa.