Api InData Clientes
  1. Api inData
Api InData Clientes
  • Api inData
    • Introducción
    • Autenticación
    • Respuestas del API
    • Client
      • Crear cliente
      • Actualizar cliente
      • Obtener cliente por código
    • ClientBranch
      • Crear una nueva sucursal de cliente
      • Actualizar una sucursal de cliente
      • Obtener una sucursal de cliente por código
    • Employee
      • Create Employee
      • Actualizar empleado
      • Obtener Empleado
      • Actualizar foto empleado
    • OperationalSite
      • Crear sitio operativo / puesto
      • Actualizar sitio operativo / puesto
      • Obtener sitio operativo / puesto
    • HoursWorked
      • Consulta horas trabajadas
  1. Api inData

Autenticación

Descripción de la Autenticación#

Para acceder a la API de indata, se implementa un sistema de autenticación robusto que utiliza JSON Web Tokens (JWT) y claves de API de AWS para garantizar la seguridad y el control de acceso. Aquí te explicamos cómo funciona:

Autenticación con JWT#

Generación del Token:
Los usuarios deben autenticarse en el backend de indata mediante la URL https://app.indata.com.co.
Una vez autenticados, los usuarios pueden generar un Token de Validación (Token JWT) desde el área de usuarios para cada cuenta que requiera acceso a la API.
Uso del Token JWT:
En cada solicitud a la API, el usuario debe incluir el JWT en el encabezado de la solicitud.
El formato del encabezado debe ser: Authorization: Bearer <token>.
El token JWT contiene la información de autenticación y autorización, asegurando que solo usuarios válidos puedan acceder a los recursos protegidos.

Claves de API (API Keys)#

Generación de la Clave de API:
Las claves de API se generan desde la configuración general del sistema y son únicas por cuenta.
Estas claves son administradas a través de AWS API Gateway, proporcionando un nivel adicional de control y seguridad.
Uso de la Clave de API:
En cada solicitud a la API, además del JWT, es necesario incluir la clave de API en el encabezado.
El formato del encabezado debe ser: x-api-key: <api-key>.
Esta clave permite controlar el acceso y gestionar los planes de uso, asegurando que cada cuenta utilice los recursos de manera eficiente y segura.

Ejemplo de Solicitud Autenticada#

Aquí tienes un ejemplo de cómo debe verse una solicitud autenticada:
Modified at 2024-07-09 19:36:11
Previous
Introducción
Next
Respuestas del API
Built with