Endpoints Autocosmos API V3
Si prefieres puedes usar el openapi.json (aka swagger.json). Ten cuidado a generarte el código del client porque, muchas veces, los generadores de código generan mucho para resolver poco.Estas páginas de documentación están generadas dinámicamente desde el openapi.json así que la información es la misma, sólo está reorganizada para graficarla.
Agencias
Gestión de agencias/concesionarios asociado a tu app.
| Method | URL Path | Descripción |
|---|---|---|
| GET | /v3/agencias | Lista de Agencias. |
| GET | /v3/agencias/{adminmail} | Información de la agencia. |
| GET | /v3/agencias/{adminmail}/productos | Estado del paquete de publicaciones de una agencia. |
| PUT | /v3/agencias/{adminmail} | Modifica los datos de una Agencia. |
| POST | /v3/agencias | Invita una Agencia a registrarse en Autocosmos. Se enviará un email a la dirección especifícada en la propiedad AdminMail. Quién lo reciba, deberá seguir la indicaciones para registrar su agencia en Autocosmos. Si tu App está suscripta a las notificaciones (endpoint AppNotificaciones), recibirás un webhook cuando el usuario se registre. Si no estas suscripto podrás consultar el estado de la invitación usando la Location, que te devolvimos en el header, con el HTTP-Method OPTIONS o GET. |
| PATCH | /v3/agencias/{adminmail}/desasociar | Desasocia una agencia de la app. La agencia podrá seguir usando su cuenta en Autocosmos, eventualmente recuperando sus publicaciones que quedarán suspendidas. |
AppNotificaciones
Gestión de notificaciones asociadas a tu app.
| Method | URL Path | Descripción |
|---|---|---|
| GET | /v3/appnotificaciones | Lista de topics disponibles y configurados para tu app. |
| GET | /v3/appnotificaciones/{topic} | Configuración webhook. |
| PUT | /v3/appnotificaciones/{topic} | Modificación de la configuración del webhook. |
| POST | /v3/appnotificaciones/{topic} | Crea la configuración del webhook. |
| DELETE | /v3/appnotificaciones/{topic} | Elimina la configuración del webhook. |
Carrocerias
Carrocerías (aka body-styles).
| Method | URL Path | Descripción |
|---|---|---|
| GET | /v3/carrocerias | Lista carrocerías. |
| GET | /v3/carrocerias/bestmatch | Búsqueda de carrocería que mejor encaja según los parámetros de suministrados. |
| GET | /v3/carrocerias/{id} | Carrocería por Id. |
Ciudades
Queries de ciudades.
| Method | URL Path | Descripción |
|---|---|---|
| GET | /v3/ciudades | Lista de ciudades de una región (provincia - estado). |
| GET | /v3/ciudades/bestmatch | Búsqueda de la ciudad que mejor encaja según los parámetros suministrados. Este es tu mejor amigo para evitar mapeo de estados/provincia/región y ciudad, entre tus valores y los registrados en Autocosmos, antes enviarnos una dirección. |
| GET | /v3/ciudades/{id} | Ciudad por Id. |
Colores
Queries de colores de autos.
| Method | URL Path | Descripción |
|---|---|---|
| GET | /v3/colores | Lista de Colores. |
| GET | /v3/colores/{id} | Color por Id. |
Consultas
Consultas recibidas.
| Method | URL Path | Descripción |
|---|---|---|
| GET | /v3/consultas/{adminmail} | Consultas recibidas en un determinado periodo. La lista, paginada, representa las consultas recibidas a las publicaciones que fueron publicadas por tu app. En el caso tu app esté habilitada por la agencia, podrás acceder a otros tipo de consultas que serán incluidas siempre en la misma lista. |
| GET | /v3/consultas/{adminmail}/{sid} | Consulta. |
| POST | /v3/consultas/{adminmail}/{sid}/resendwebhook | Vuelve a enviar el WebHook de una consulta específica relativamente reciente. |
Home
Home de la API. Para surfing de la API tal vez te convenga empezar por acá usando la "Play-station". Si logras navegar la API sin conocer las URLs, dejandote llevar por los '_links', tal vez descubras que no es necesario guardar muchas Urls y paths en tu código; tal vez las 'relationship' (nombres de propiedades del object '_links') sean las que ayuden. Tal vez descubras que, si tu código empieza por la home de la API, logres navegarla solo conociendo los nombres de propiedades de las entidades que se quiere gestionar.
| Method | URL Path | Descripción |
|---|---|---|
| GET | /v3 | Puntos de entrada a la API. Los entry-points no son estrictamente relacionados entre si; en varios casos desde un punto de entrada accedes a otros puntos (como navegando desde la home de un sitio a sus páginas internas). |
Marcas
Marcas de autos.
| Method | URL Path | Descripción |
|---|---|---|
| GET | /v3/marcas | Lista de Marcas. |
| GET | /v3/marcas/bestmatch | Búsqueda de marca que mejor encaja según los parámetros suministrados. |
| GET | /v3/marcas/{id} | Marca por Id |
Modelos
Modelos de una marca.
| Method | URL Path | Descripción |
|---|---|---|
| GET | /v3/modelos | Lista de Modelos de una marca. |
| GET | /v3/modelos/bestmatch | Búsqueda de modelo que mejor encaja según los parámetros suministrados. |
| GET | /v3/modelos/{id} | Modelo. |
Monedas
Monedas por país según las comúnmente usadas para la compra/venta de autos.
| Method | URL Path | Descripción |
|---|---|---|
| GET | /v3/monedas | Lista de Monedas. |
| GET | /v3/monedas/bestmatch | Búsqueda de monedas que mejor encaja según los parámetros suministrados. |
| GET | /v3/monedas/{id} | Moneda por Id. |
Notificaciones
Gestión de notificaciones de agencias/concesionarios. Agencias y colaboradores pueden tener activas múltiples notificaciones asociadas a varios eventos de su cuenta. Una app, por API, solo puede gestionar notificaciones relacionadas a la publicaciones de la agencia, en general, o del administrador de la cuenta (solo activación desactivación mails HTML).
| Method | URL Path | Descripción |
|---|---|---|
| GET | /v3/notificaciones/{adminmail} | Notificaciones de una Agencia. |
| PUT | /v3/notificaciones/{adminmail} | Modifica las notificaciones de una Agencia/Concesionaria |
Operadores
Gestión operadores de agencias/concesionarios.
| Method | URL Path | Descripción |
|---|---|---|
| GET | /v3/operadores | Colaborador de una Agencia. |
| GET | /v3/operadores/{adminmail} | Colaboradores de una Agencia. |
| PUT | /v3/operadores/{adminmail} | Modificación de la información del administrador. Un operador debería gestionar sus propios datos personales, incluyendo direcciones de ventas y telefonos, directamente accediendo a su cuenta en Autocosmos mientras que por API solo se debería usar la información personal configurada. En el caso de administrador de agencia, solo si creado por API, es posible modificar la información. |
| POST | /v3/operadores/{adminmail}/invitar | Invitación colaborador de agencia. Envía un e-mail al colaborador para que acepte la invitación. En el caso no sea registrado podrá registrarse siguiendo los pasos del e-mail. |
| PATCH | /v3/operadores/{adminmail}/desasociar | Desasocia un colaborador de una agencia. El colaborador quedará como usuario de Autocosmos y podrá ser invitado a operar con otra agencia. |
Propulsiones
Propulsiones (aka combustibles).
| Method | URL Path | Descripción |
|---|---|---|
| GET | /v3/propulsiones | Lista de propulsiones. |
| GET | /v3/propulsiones/bestmatch | Búsqueda de propulsión que mejor encaja según los parámetros suministrados. |
| GET | /v3/propulsiones/{id} | Propulsión por Id. |
Publicaciones
Gestión de agencias/concesionarios asociado a tu app, asociación o grupo.
| Method | URL Path | Descripción |
|---|---|---|
| GET | /v3/publicaciones/{adminmail} | Lista de Publicaciones. |
| GET | /v3/publicaciones/{adminmail}/{externalid} | Publicacion por ExtenalId. |
| PUT | /v3/publicaciones/{adminmail}/{externalid} | Modificación publicación. |
| POST | /v3/publicaciones/{adminmail} | Crea una publicación de auto. |
| PATCH | /v3/publicaciones/{adminmail}/{externalid} | Modifica el Precios de una Publicación. |
| PATCH | /v3/publicaciones/{adminmail}/{externalid}/activar | Activa la publicación si están dada las condiciones para que eso suceda. Hay varios motivos por los cuales no es posible activar una publicación: la suscripción no tiene espacio suficiente, el operador o la suscripción están suspendidos, etc. |
| PATCH | /v3/publicaciones/{adminmail}/{externalid}/suspender | Suspende la publicación si están dada las condiciones para que eso suceda. Suspender una publicación implica: la publicación no será visible en los listados, la publicación no podrá recibir consultas. Una publicación suspendida puede volver a se activada. |
| PATCH | /v3/publicaciones/{adminmail}/{externalid}/archivar | Archiva la publicación. Una vez archivada la publicación no podrá ser modificada (incluye no podrá ser reactivada). |
Regiones
Queries de provicias, estados, regiones etc.
| Method | URL Path | Descripción |
|---|---|---|
| GET | /v3/regiones | Lista de todas las regiones (provincias o estados según corresponda por cada país). |
| GET | /v3/regiones/bestmatch | Búsqueda de regiones que mejor encaja según los parámetros suministrados. |
| GET | /v3/regiones/{id} | Región (provincia o estado según corresponda por cada país) por Id. |
Sucursales
Gestión de sucursales de agencias/concesionarios.
| Method | URL Path | Descripción |
|---|---|---|
| GET | /v3/sucursales/{adminmail} | Sucursales de una Agencia. |
| GET | /v3/sucursales/{adminmail}/{id} | Información de una sucursal de una agencia. |
| PUT | /v3/sucursales/{adminmail}/{id} | Modificación de la información de una sucursal. |
| POST | /v3/sucursales/{adminmail} | Crea una nueva Sucursal |
| DELETE | /v3/sucursales/{adminmail}/{id} | Elimina una sucursal de una Agencia. |
Tests
Operaciones de prueba. Úsalo para verificar que tu client tiene acceso y esta bien implementada la autenticación basada en HMAC.
| Method | URL Path | Descripción |
|---|---|---|
| GET | /v3/tests | Test, para tu autenticación, en GET. |
| GET | /v3/tests/{id} | Test, para tu autenticación, en GET: valor único. |
| PUT | /v3/tests/{id} | Test, para tu autenticación, en PUT (envía algún valor así incluyes el test de 'Digest' para el calculo del HMAC). |
| POST | /v3/tests | Test, para tu autenticación, en POST (envía algún valor así incluyes el test de 'Digest' para el calculo del HMAC). |
| DELETE | /v3/tests/{id} | Test, para tu autenticación, en DELETE. |
| PATCH | /v3/tests/{id} | Test, para tu autenticación, en PATCH. |
Versiones
Queries de versiones de modelos de autos.
| Method | URL Path | Descripción |
|---|---|---|
| GET | /v3/versiones | Lista de Versiones de un modelo (rel: href, find, search). |
| GET | /v3/versiones/bestmatch | Búsqueda de versión que mejor encaja según los parámetros suministrados. Este es tu mejor amigo para evitar mapeo de marca y modelo, entre tus valores y las marcas/modelos en Autocosmos, antes de publicar un auto. |
| GET | /v3/versiones/{id} | Versión por Id. |
Visitas
Queries de visitas.
| Method | URL Path | Descripción |
|---|---|---|
| GET | /v3/visitas/{adminmail} | Visitas diarias a publicaciones de una agencia. Últimos 3 meses. Para agencias con ~2000 publicaciones, o menos, este método permite analizar visitas de todas las publicaciones en un mes en un tiempo razonable. Evita polling, si quieres seguir teniendo acceso a esta funcionalidad. |