Saltar al contenido principal

Inicio Rápido

tip

Comience de inmediato y realice su primera solicitud API para obtener la lista de vehículos aquí.

Comenzar con la Cartrack Fleet API es sencillo. Esta sección ofrece un ejemplo básico de cómo hacer su primera llamada API. Aunque este ejemplo usa curl, una herramienta versátil y ampliamente soportada para realizar solicitudes HTTP desde la línea de comandos, puede aplicar los mismos principios a otros lenguajes y herramientas como Python, JavaScript o cualquier librería cliente HTTP.

Requisitos Previos​

Antes de continuar, asegúrate de tener:

  • cURL instalado: Verifique que cURL esté instalado en su sistema. cURL suele venir disponible en Unix, Linux y macOS, y puede instalarse en Windows.
  • Base URL y credenciales de autenticación: Necesitas la base URL de la Cartrack Fleet API y credenciales válidas. Para obtenerlas, consulta Authentication y Base URLs en nuestra documentación.

Realizar una llamada API​

Así puedes hacer una llamada API para recuperar una lista de vehículos usando curl:

curl --location '{baseUrl}/rest/vehicles' \
--header 'Accept: application/json' \
--header 'Authorization: Basic your_encoded_credentials'

Reemplaza {baseUrl} con la base URL real de la Cartrack Fleet API, y reemplaza your_encoded_credentials con sus credenciales de autorización codificadas en Base64.

Entender el comando​

  • --location: Indica a curl que siga redirecciones enviadas por el servidor como parte de la solicitud HTTP.
  • --header: Permite especificar encabezados adicionales en la solicitud. En este ejemplo, indicamos que aceptamos respuestas en formato JSON e incluimos credenciales de autorización.
  • La URL del endpoint ({baseUrl}/rest/vehicles) especifica el endpoint API para recuperar la lista de vehículos.

Respuesta​

La API devuelve una respuesta JSON con una lista de vehículos, cada uno con detalles como ID del vehículo, modelo y otra información relevante.

Este ejemplo básico proporciona una base inicial para realizar llamadas API a la Cartrack Fleet API. Puede adaptarlo al lenguaje o herramienta de su elección siguiendo los mismos principios. Para más detalle sobre funcionalidades y endpoints adicionales, continúa explorando nuestra documentación completa.

Importar en Postman​

Puedes importar la especificación OpenAPI de Cartrack en Postman para generar una colección de solicitudes lista para usar.

  • URL del spec: https://developer.cartrack.com/openapi/openapi.yaml
  • En Postman: haz clic en Import → Link, pega la URL y luego haz clic en Import. O usa Import → File y carga el archivo openapi.yaml descargado.
  • Postman creará una colección de solicitudes basada en el spec.
  • Configura valores de entorno:
    • Define la base URL usando la guía de la página Base URLs.
    • Configura autenticación: las APIs de Cartrack usan Basic Authentication. En Postman, abre cualquier request, ve a la pestaña Authorization, elige Basic Auth e introduce usuario y contraseña. Alternativamente, agrega el encabezado Authorization con el valor Basic <base64-encoded-credentials>. Consulta Authentication para más detalle sobre cómo generar credenciales.
  • Ejecuta solicitudes individuales o usa Collection Runner para ejecutar múltiples llamadas.