Persat Api
  • Persat API v1.0
  • Introducción
    • ¿Qué es una API?
    • ¿Cómo funciona?
  • Primeros Pasos
    • Introducción
    • Niveles de Acceso y Consideraciones Importantes
    • Formato de Respuesta
    • Autenticación
      • Como obtener el Api key
    • Configurar Webhooks
      • Primeros pasos
      • Lógica de reintentos
  • Entidades Básicas
    • Clientes
      • Obtener un cliente
      • Agregar un cliente
      • Modificar un cliente
      • Eliminar un cliente
      • Listar Clientes
      • Listar Grupos de Clientes
      • Listar Tipos de Clientes
      • Listar Campos Personalizados
      • Eventos / Webhooks
        • Cliente creado
        • Cliente modificado
        • Cliente eliminado
    • Objetos en Cliente
      • Obtener estructura/esquema de un Objeto en Cliente
      • Listar estructuras/esquemas de los Objetos en Cliente
      • Obtener objeto
      • Insertar objeto
      • Modificar objeto
      • Eliminar objeto
      • Listar Objetos en un Cliente particular
      • Sincronizacion completa
    • Master Db
      • Obtener estructura/esquema de una Master Db
      • Listar estructuras/esquemas de las Master Dbs
      • Obtener elemento
      • Insertar elemento
      • Modificar elemento
      • Eliminar elemento
      • Sincronizacion completa
    • Dispositivos
      • Obtener Dispositivo
      • Listar Dispositivos
    • Usuarios
      • Listar Usuarios
      • Listar Técnicos Activos
    • Seguimientos
      • Crear seguimientos
  • Modulos
    • 🚚Rastreo Satelital
      • Obtener última posición GPS
      • Obtener estadísticas de Rastreo
      • Obtener Visitas a Clientes
      • Integrar Dispositivos de Rastreo a Persat
    • ☑️Formularios Digitales
      • Obtener estructura/esquema de un Formulario
      • Listar estructuras/esquemas de todos los Formularios
      • Obtener formulario
      • Obtener PDF del formulario
      • Tipos de Widgets
        • Campo Texto
        • Campo Párrafo
        • Campo Link
        • Campo Número
        • Campo Fecha
        • Campo Hora
        • Seleccion Simple
        • Lista Desplegable
        • Selección Múltiple
        • Campo Foto (deprecado)
        • Campo Fotos
        • Firma Digital (deprecado)
        • Firma Digital v2
        • Etiquetas
        • Tabla Smart
        • Tabla Master Db
        • Lista de Objetos en Cliente
        • Tabla de Objetos en Cliente
      • Insertar formulario
      • Modificar formulario
      • Modificar estado de formulario
      • Listar historial de estados de un formulario
      • Listar formularios
      • Estados de formulario
        • Obtener estado
        • Listar estados
      • Eventos / Webhooks
        • Formulario Creado
        • Formulario Modificado
        • Formulario estado modificado
        • Formulario estado modificado masivamente
    • 🛠️Órdenes de Trabajo
      • Obtener estructura/esquema de un Tipo de OT
      • Listar estructuras/esquemas de todos los tipos de OTs
      • Administrar Etiquetas
        • Obtener Etiqueta
        • Insertar Etiqueta
        • Modificar Etiqueta
        • Eliminar Etiqueta
        • Listar Etiquetas
      • Obtener OT
        • PENDIENTE sin instrucciones
        • PENDIENTE con instrucciones
        • PROYECTADA sin instrucciones
        • PROYECTADA con instrucciones
        • ASIGNADA
        • INFORME
        • VENCIDA
        • CERRADA_OK
        • CERRADA_CON_DESVIO
        • CERRADA_NO_CUMPLIDA
      • Obtener PDF de la OT
      • Insertar OT
        • Insertar PENDIENTE
        • Insertar PROYECTADA
        • Insertar ASIGNADA
      • Modificar OT
        • Modificar etiquetas
        • Cancelar OT
        • Mover a estado PENDIENTE
      • Listar OTs
      • Obtener link de trackeo
      • Eventos / Webhooks
        • OT creada
        • OT modificada
        • OT finalizada
        • OT cerrada
    • 📦Gestión de Entregas
      • Obtener estructura/esquema de un Tipo de Entrega
      • Listar estructuras/esquemas de todos los tipos de Entregas
      • Administrar Etiquetas
        • Obtener Etiqueta
        • Insertar Etiqueta
        • Modificar Etiqueta
        • Eliminar Etiqueta
        • Listar Etiquetas
      • Obtener entrega
        • Estado PENDING
        • Estado ROUTING
        • Estado ASSIGNED
        • Estado FINISHED
        • Estado FINISHED_WITH_DEVIATION
        • Estado NOT_FINISHED
      • Obtener PDF de entrega
      • Crear entrega
        • Crear Entrega Simple
        • Crear Entrega en Cliente
      • Eliminar entrega
      • Listar Entregas
      • Obtener link de trackeo
      • Eventos / Webhooks
        • Entrega Creada
        • Entrega Finalizada
        • Entrega Eliminada
      • Rutas de Entrega
        • Obtener Ruta
        • Listar Rutas
        • Eventos / Webhooks
          • Ruta Asignada
          • Ruta Modificada
          • Ruta Cancelada
Powered by GitBook
On this page
  1. Entidades Básicas
  2. Usuarios

Listar Usuarios

Last updated 3 months ago

Para obtener un listado de los usuarios y sus asignados, se debe enviar un GET como el que se especifica a continuación.

GET https://api.persat.com.ar/v1/users

Headers

Name
Type
Description

Authorization*

String

Bearer API_KEY

{
    "success": true,
    "data": [
        {
            "user_id": 23
            "group_id": 1,
            "name": "administrativo1@gmail.com",
            "real_name": "Juan Perez",
            "admin": true,
            "verified": true,
            "deleted": false,
        },
        {
            "user_id": 24,        
            "group_id": 1,
            "name": "supervisor@gmail.com",
            "real_name": "Sebastian Gonzalez",
            "admin": false,
            "verified": true,
            "deleted": false,
            "devices": [
                2,
                5,
                3,
                10
            ]
        },     
        {
            "user_id": 27,        
            "group_id": 1,
            "name": "chofer1@gmail.com",
            "real_name": "Diego Rodriguez",
            "admin": false,
            "verified": true,
            "deleted": false,
            "devices": [
                2
            ]
        }, {...}       
    ]
}

Analizando la Respuesta

En caso que no haya ningun error, obtenemos

{
    "success": true,
    "data": [
        {
            "user_id": 23
            "group_id": 1,
            "name": "administrativo1@gmail.com",
            "real_name": "Juan Perez",
            "admin": true,
            "verified": true,
            "deleted": false,
        },
        {
            "user_id": 24,        
            "group_id": 1,
            "name": "supervisor@gmail.com",
            "real_name": "Sebastian Gonzalez",
            "admin": false,
            "verified": true,
            "deleted": false,
            "devices": [
                2,
                5,
                3,
                10
            ]
        },     
        {
            "user_id": 27,        
            "group_id": 1,
            "name": "chofer1@gmail.com",
            "real_name": "Diego Rodriguez",
            "admin": false,
            "verified": true,
            "deleted": false,
            "devices": [
                2
            ]
        }, {...}       
    ]
}

Lo que se recibe es un array en donde cada elemento son los datos de un usuario.

user_id: Es un Number, identificando inequivocamente al usuario.

group_id: No usar. Es un field interno por el momento.

name: Email del usuario. Con este email y su contraseña, puede acceder al sistema tanto en la web como en Android.

real_name: Nombre de pila de la persona. Puede ser Nombre y Apellido, o el modelo y la patente del vehículo, o cualquier indicador que sea de utilidad para la empresa.

admin: Es un Boolean. En caso de true, el usuario es un Administrador del sistema, con lo cual tiene acceso total y visualización total.

verified: Es un Boolean, indicando si el email del usuario fue verificado. No tiene un uso particular específico.

deleted: Es un Boolean. Indicando si el usuario está activo actualmente.

Los usuarios admin, no poseen el field devices, ya que pueden visualizar todo.

Generalmente, los usuarios que son choferes, o técnicos poseen un solo dispositivo asignado (su propio celular o equipo de rastreo en su vehiculo), mientras que los supervisores suelen tener varios devices asignados para poder visualizar y generar los reportes correspondientes

devices: Es un Array de Numbers. Indica cuales puede visualizar este usuario.

Dispositivos
Dispositivos