Guía de la API de EasyCargo (parte 1)
Al navegar por nuestra página web es posible que se haya encontrado con el término API. Esta abreviatura está estrechamente relacionada con la industria de la informática, por lo que es posible que no entienda del todo en qué consiste este servicio y qué beneficios puede obtener de él. Vamos a analizar qué es una API y cómo funciona. Pensamos que vale la pena familiarizarse con este tema, ya que, por ejemplo, le ayudará a ampliar la funcionalidad del software para su empresa. Así que hemos decidido crear una serie de tres partes para cubrir este tema de una manera apropiada. Hoy nos centraremos en la parte teórica. En la conclusión de este artículo, conocerá el contenido de los próximos artículos de la serie.
Fuente: https://bykowski.pl/wp-content/uploads/2021/06/api-przyklad-dzialania-1.jpg
El diagrama anterior muestra el papel de la API de una manera muy simple. Sin embargo, vale la pena responder a la pregunta de antemano: ¿qué es una API? El acrónimo significa interfaz de programación de aplicaciones. Hay diferentes tipos de API: nosotros tenemos una REST API. Su significado no debería importarle mucho, así que no nos centraremos estrictamente en el tipo de API aquí. Una interfaz de programación de aplicaciones es un conjunto específico de soluciones mediante las cuales puedes utilizar los datos de otro servicio en su propio sitio web o software. ¿Qué significa? Si su empresa tiene un servicio interno para gestionar, por ejemplo, el transporte, puede descargar los datos de su cuenta en EasyCargo, que luego se enviarán directamente al software de la empresa.
Sin embargo, para comunicarse con EasyCargo u otro software a través de la API, se necesitará una clave API. Esta nos permite identificar su sitio web cuando interactúa con EasyCargo. Si desea obtenerla, póngase en contacto con nosotros por correo electrónico en soporte@easycargo3d.com o mediante nuestro formulario de contacto. Una vez generada la clave, puede encontrarla desde su perfil de usuario en la esquina superior derecha haciendo clic en el botón Mostrar clave API.
Nota: maneje tu clave de API como lo haría con la contraseña de su cuenta: guárdela para usted.
Habiendo dejado atrás la información más importante sobre las API, podemos pasar por fin a explicar la función de la interfaz de programación de aplicaciones basada en el diagrama.
Creemos que en esta parte del artículo ya habrá entendido la idea general de cómo funciona la API. Puede encontrar la interfaz de programación de aplicaciones de EasyCargo en este enlace. Todavía queremos llamar su atención sobre el hecho de que todos los ejemplos de consulta en la documentación de la API están escritos usando HTTP. Le recomendamos que utilice el protocolo HTTPS más seguro.
En resumen, la primera parte de la serie se ha centrado principalmente en explicar qué es la API y cuál es la idea que la sustenta. El próximo artículo será más práctico. Intentaremos que se familiarice con el uso de la API de EasyCargo, entre otras cosas utilizando nuestro API para clientes. Comprobará por sí mismo que las solicitudes adecuadas a la interfaz de programación de EasyCargo dan como resultado los datos requeridos. En la última parte de la serie, hablaremos de lo que hace posible la comunicación a través de la API con EasyCargo.
