Skip to main content
Version: Latest

Autenticación

Se obtiene token con vigencia de una hora para usuarios autorizados por aveonline

Cuenta de demostración

El usuario y la clave de los ejemplos son de una cuenta de demostración pública, la misma para todo el mundo. Está publicada a propósito, para que puedas probar la integración de punta a punta antes de tener credenciales propias.

Qué no hace: no ejecuta operaciones reales, no factura, y las guías que crees con ella no se envían al operador logístico.

Tus credenciales definitivas se entregan por un canal seguro cuando la integración está validada.

Request 🚀​

Base url​

https://app.aveonline.co/api/comunes/v1.0/autenticarusuario.php

Method​

POST

Content-Type: application/json

Params JSON​

  • tipo* String Enrutador de la API, "auth"
  • usuario* String Usuario de ingreso a la plataforma
  • clave* String Contraseña actual de ingreso a la plataforma

Ejemplo​

{
  "tipo": "auth",
  "usuario": "demointegracion",
  "clave": "demointegra2021"
}

Response 📄​

Success​

  • status String Estado del resultado
  • message String Mensaje de respuesta
  • token String Llave de seguridad para consumo de las API con vigencia de una hora
  • cuentas Array Object -> [{}]
    • servicio String Unidad de negocio asociada a la cuenta
    • usuarios Array Object -> [{}]
      • id Number Identificador del usuario dentro de AVEONLINE
      • documento String NIT o cédula relacionada al usuario
      • usuario String Usuario o login que fue ingresado como parametro
      • nombre String Nombre de la cuenta
      • razon String Razón social del usuario
      • asesorlogistico String Identificador del asesor logístico asignado
      • nombreasesor String Asesor logístico asignado

Ejemplo​

{
  "status": "ok",
  "message": "usuario encontrado",
  "token": "TU_TOKEN_JWT",
  "cuentas": [
    {
      "servicio": "AVEONLINE COURIER",
      "usuarios": [
        {
          "id": 15289,
          "documento": "00000",
          "usuario": "demointegracion",
          "nombre": "Demo- Integracion",
          "razon": "Demo - Integracion",
          "asesorlogistico": null,
          "nombreasesor": null
        }
      ]
    }
  ]
}

Error​

No se encuentran datos asociados​

{
  "status": "error",
  "message": "No se encontraron resultados"
}

Las contraseña no coincide y NO se lista registro​

{
  "status": "ok",
  "message": "usuario encontrado", // omitir
  "token": "TU_TOKEN_JWT",
  "cuentas": []
}