API INTERMEDIA TWIN DOLPHIN - COGNITIVE

API INTERMEDIA TWIN DOLPHIN - COGNITIVE

1. Objetivo del Desarrollo

Se implementó una API intermedia que permite al equipo de Cognitive acceder —de forma segura y controlada— a la información actualizada del personal de Twin Dolphin registrada en eClock Go. La API expone únicamente los datos necesarios, sin comprometer las credenciales ni los accesos administrativos de la cuenta de Twin Dolphin.

2. Alcance funcional

  • Se desarrolló una única API RESTful con un solo endpoint accesible exclusivamente por Cognitive.

  • La API consulta directamente la base de datos de eClock Go del cliente Twin Dolphin.

  • Opera en modo de solo lectura (GET) y quedó configurada para ejecutarse una vez al día; no está optimizada para llamadas repetitivas en intervalos cortos.

  • Se generó una ApiKey y un Token dedicados a Cognitive, con permisos limitados a esta operación.

3. Endpoint Disponible

Ruta: GET /api/Suscripciones/{SuscripcionID}/Colaboradores

3.1 Datos devueltos

La respuesta incluye registros de colaboradores activos y dados de baja. Campos:

Colaborador.Borrado
Colaborador.LinkID
Colaborador.NombreCompleto
Colaborador.FechaIngreso
Colaborador.FechaAntiguedad
Colaborador.CentroCosto.Etiqueta
Colaborador.Puesto.LinkID
Colaborador.Departamento.Etiqueta
Laborales.NivOrg
Laborales.Staff_Type
Colaborador.Empresa.RazonSocial
Colaborador.Ubicacion.Etiqueta
Colaborador.TipoContrato
Laborales.PosicionPresupuestada
Laborales.TipoContratacion
Colaborador.FechaBaja
Colaborador.Baja.AuditoriaCambio.Valor.MotivoTD
Colaborador.Baja.Comentarios

4. Credenciales y Acceso

  1. Se dio de alta un usuario técnico del equipo de Cognitive en la cuenta Twin Dolphin de eClock Go.

  2. A este usuario se le generó:

    • ApiKey exclusiva

    • Token con permisos restringidos al endpoint descrito.

  3. Las credenciales fueron compartidas de manera privada con el equipo de Cognitive y se almacenan bajo sus políticas internas de seguridad.

Nota: Para rotar el token o regenerar la ApiKey, solicitarlo al área de soporte eClock.

5. Ejemplos de Consumo

5.1 cURL

curl -X GET \
https://ApiB.Cognitive.eClock.com.mx/api/Suscripciones/{SuscripcionID}/Colaboradores \
-H "ApiKey: <SuApiKey>" \
-H "Authorization: Bearer <SuToken>"

5.2 PowerShell

# ---------- 1) Define tus credenciales ----------
$SuscripcionID = 1234 # Sustituye por tu ID real
$ApiKey = 'TuApiKeyAquí' # Sustituye por tu ApiKey
$Token = 'TuTokenAquí' # Sustituye por tu token JWT

# ---------- 2) Prepara los encabezados ----------
$headers = @{
'ApiKey' = $ApiKey
'Authorization' = "Bearer $Token"
}

# ---------- 3) Lanza la petición ----------
Invoke-RestMethod \
-Method Get \
-Uri "https://ApiB.Cognitive.eClock.com.mx/api/Suscripciones/$SuscripcionID/Colaboradores" \
-Headers $headers

6. Consideraciones finales

El desarrollo de la API intermedia se encuentra completado y validado en entorno de pruebas. Proporciona al equipo de Cognitive un endpoint seguro y dedicado para consultar la información de recursos humanos de Twin Dolphin sin exponer credenciales sensibles. Con los objetivos funcionales ya cubiertos y las credenciales exclusivas asignadas, el servicio está preparado para pasar a fase de Producción en cuanto ambas partes concluyan sus pruebas de aceptación. Esto garantiza una integración estable.