Navixy se compromete a hacer que los datos telemáticos sean fácilmente accesibles para socios y desarrolladores, mejorando continuamente nuestros productos para que sean fáciles de usar y claros.
En este artículo, aprenderá cómo utilizar nuestra nueva Colección de API de Navixy en Postman para agilizar su proceso de desarrollo de API. Demostraremos cómo la documentación completa para cada llamada y resultado, junto con la capacidad de probarlas instantáneamente con datos reales o de demostración, hace que trabajar con APIs sea más fácil y eficiente.
En Navixy, la flexibilidad de la plataforma es nuestra prioridad. Además de nuestras soluciones PaaS y On-Premise, ofrecemos nuestros APIs como un conjunto de herramientas fácil de usar para desarrolladores, para simplificar el desarrollo y la integración. Nuestra colección de APIs de Navixy y los entornos de Postman, respaldados por documentación exhaustiva, le permiten crear soluciones de telemática personalizadas adaptadas a las necesidades de sus clientes.
– Andrey Melnik, Jefe de Soporte Técnico en Navixy
La documentación y los desafíos del método de prueba y error
La integración de APIs puede ser un proceso que consume mucho tiempo y resulta frustrante. Los desarrolladores a menudo deben lidiar con una extensa documentación, tratando de entender la plataforma e identificar los métodos correctos para sus escenarios específicos. A pesar de contar con ejemplos de llamadas y guías paso a paso, el proceso sigue siendo ineficiente.
El principal desafío es la falta de pruebas inmediatas para diferentes llamadas, lo que impide ver los resultados y evaluar la conveniencia de recibir información a través de ellos. En ese momento, los desarrolladores buscan manualmente las llamadas correctas, pasando por múltiples intentos de prueba y error, lo cual es tanto un proceso que consume mucho tiempo como propenso a errores.
API Sandbox de Navixy: una solución impulsada por Postman para pruebas de API
Para hacer el Desarrollo de API ay la integración más fácil y eficiente, recurrimos a la plataforma Postman, que permite a los desarrolladores crear, probar y gestionar colecciones de API con facilidad. Por eso, nos complace presentar el API de Navixy Sandbox, una nueva herramienta para trabajar con documentación de API y explorar y probar consultas de API con datos reales o de demostración.
¿Por qué elegimos Postman?
Postman es una plataforma para el desarrollo, prueba y gestión de API utilizada por más de 30 millones de desarrolladores en todo el mundo. Permite crear solicitudes de API, ejecutar pruebas automatizadas y depurar respuestas. Con espacios de trabajo colaborativos, colecciones, entornos y generación de documentación, Postman simplifica el proceso de desarrollo de API y permite a los desarrolladores y equipos construir, compartir e iterar en APIs de manera más efectiva. La plataforma apoya y promueve el enfoque de desarrollo basado en API, para el cual ha sido reconocido como un Visionario por Gartner varias veces seguidas en los últimos años.
Con el API de Navixy Sandbox, todo es sencillo. Puede trabajar con datos aquí y ahora y usar las llamadas que ha probado en sus colecciones y automatizaciones. Además, puede utilizar variables y entornos, ahorrándole a usted y a sus desarrolladores mucho tiempo.
Para comenzar a usar el API de Navixy Sandbox, necesita descargar o usar Postman online. Inicie sesión en su cuenta de Postman o cree una nueva de forma gratuita si aún no tiene una. Luego, ingrese "Navixy API Sandbox" en la barra de búsqueda y selecciónelo de la lista de resultados.
Nuestra documentación está disponible públicamente para cualquier persona que desee comenzar a trabajar con nuestras API. Sin embargo, si intenta enviar una solicitud de API directamente desde la documentación, Postman le pedirá que realice un paso adicional antes de continuar. Este paso es necesario para garantizar la seguridad de sus datos y evitar accesos no autorizados. Abordaremos este aspecto en la siguiente sección.
Cómo trabajar con la API de Navixy en Postman: espacios de trabajo y entornos
Para comenzar a enviar solicitudes de API, necesitará crear su propio fork de nuestra colección.
Nota importante : Si está utilizando la aplicación Postman, debe actualizarla a la última versión para poder crear forks como se describe aquí.
Para hacerlo, haga clic en el botón "Fork", como se muestra en la captura de pantalla a continuación.
A continuación, proporcione toda la información necesaria sobre su fork:
- Fork label – es el nombre de su fork en su espacio de trabajo.
- Workspace label – el espacio de trabajo al que está agregando el fork.
- Environments – los entornos que desea agregar a tu fork desde nuestra colección. Puede seleccionar todos o solo los necesarios.
- Notifications – Déjelos habilitados, ya que es la forma en que recibirá actualizaciones sobre cualquier cambio en nuestro API Sandbox. Estas notificaciones llegarán al correo electrónico asociado con su cuenta de Postman.
Al crear su fork, este se abrirá automáticamente. El siguiente paso es elegir el entorno necesario. Puede encontrarlo en la esquina superior derecha, debajo de la imagen de su cuenta.
También puede seleccionarlo de la lista de entornos en el menú del lado izquierdo. Elija el que necesite y haga clic en "Set active".
¡Eso es todo!
Ahora, incluso si no tiene una cuenta de Navixy o ningún rastreador conectado, puede seleccionar el entorno de demostración y ver cómo funciona el API Sandbox con diferentes solicitudes.
Tomemos, por ejemplo, una solicitud de estado del dispositivo.
Ejemplo de solicitud: obtener el estado de un rastreador desde una cuenta de demostración
En este ejemplo, vamos a utilizar el entorno de demostración. Esto significa que el API Sandbox le proporcionará información desde la cuenta de demostración de Navixy.
Vamos a la solicitud.
Abra la sección Trackers y localice la solicitud de API "Getting tracker list".
Envíe la solicitud y localice el tracker_id necesario en la respuesta.
En la respuesta de tracker/list, este es el id que aparece antes de la etiqueta. Simplemente resaltarlo y haga clic derecho para copiarlo.
El próximo paso es localizar el ultimo estado GPS conocido de la solicitud, Pegue su tracker_id en el campo de parámetros de esta llamada API y haga clic en enviar para obtener la información necesaria.
Verá la información del último estado del tracker en el campo de resultados.
Utilice la documentación completa sobre el API de Navixy en Postman
Documentación coherente y completa es fundamental en la integración y prueba de APIs.
Cada llamada API en el API de Navixy Sandbox viene con una descripción detallada de sus parámetros, incluyendo dónde y en qué situaciones pueden ser útiles. Además, hay una descripción de los parámetros de respuesta y de los posibles errores con sus respectivas soluciones. Esta información se encuentra convenientemente ubicada debajo de cada llamada API, para que no tenga que perder tiempo buscándola.
Al leer la documentación, comprenderá de inmediato qué necesita enviar, qué recibirá y qué hacer si recibe un error en vez del resultado esperado.
Estamos comprometidos con la mejora continua del API de Navixy Sandbox. Por eso, agregaremos gradualmente descripciones detalladas a todas las llamadas API y actualizaremos el entorno de pruebas con nuevos métodos e instrucciones para trabajar con los datos de la plataforma, facilitando la creación de soluciones personalizadas para sus clientes.
Conclusión: La exploración del API de Navixy simplificada
Al comprender la necesidad de que los socios y desarrolladores puedan probar nuestro API de telemática en varios escenarios y la importancia de una documentación clara y consistente, creamos el API de Navixy Sandbox en Postman. Nuestro objetivo fue proporcionar un entorno de prueba seguro donde se pudiera leer en detalle sobre diversas llamadas API y resultados, e inmediatamente probarlas para determinar cuál se ajusta mejor a las necesidades específicas de sus clientes.
Esperamos que el API de Navixy Sandbox en Postman le ayude a ofrecer soluciones individuales a sus clientes y a hacer crecer su negocio.
¿Desea saber más sobre la API de Navixy? Contacte a nuestro equipo ahora y descubra como le podemos ayudar a desatar su potencial completo.
