Autenticación

Inicio de sesión

POST/login

Autentica a un usuario de Upnify® CRM. Envía las credenciales como parámetros de consulta exclusivamente por HTTPS y conserva tkSesion como un secreto: úsalo para autenticar las solicitudes posteriores y no lo incluyas en código, URLs compartidas ni registros. La respuesta exitosa es un arreglo con un objeto de contexto del usuario y la empresa.

Parámetros

Nombre	Tipo	Validación	Descripción
`usuario`	String	Requerido	Correo electrónico o número móvil del usuario. Codifícalo para URL.
`contrasenia`	String	Requerido	Contraseña del usuario. Codifícala para URL; no la almacenes en código, historial ni registros.

Respuesta

Nombre	Tipo	Descripción
`bucket`	Integer	Identificador numérico de la cuenta.
`tkEmpresa`	String	Token de la empresa asociada a la sesión. Trátalo como un identificador opaco.
`tkUsuario`	String	Token del usuario autenticado. Trátalo como un identificador opaco.
`mailChimp`	String	Identificador de la integración de correo, cuando esté configurada. Trátalo como dato sensible.
`tmpToken`	String	Token temporal, que puede ser nulo. Trátalo como dato sensible y no lo registres.
`tkGrupo`	String	Token del grupo de usuarios al que pertenece el usuario autenticado.
`nombre`	String	Contiene el nombre del ejecutivo o usuario de la cuenta.
`apellidos`	String	Contiene el apellido del ejecutivo o usuario de la cuenta.
`telefono`	String	Contiene el número de teléfono del ejecutivo o usuario de la cuenta.
`email`	String	Contiene el correo electrónico del ejecutivo o usuario de la cuenta.
`movil`	String	Contiene el número de teléfono móvil del ejecutivo o usuario de la cuenta.
`puesto`	String	Contiene el puesto del ejecutivo o usuario de la cuenta.
`iniciales`	String	Contiene las iniciales del ejecutivo o usuario de la cuenta.
`empresa`	String	Contiene el nombre de la empresa a la que pertenece la cuenta.
`grupo`	String	Contiene el nombre del grupo al que pertenece el ejecutivo o usuario de la cuenta.
`numeroUsuarios`	Integer	Contiene el número de usuarios asociados a la cuenta.
`empresaContacto`	String	Datos de contacto de la empresa, si están configurados.
`empresaContactoNombre`	String	Nombre del contacto de la empresa, si está configurado.
`empresaContactoApellidos`	String	Apellidos del contacto de la empresa, si están configurados.
`empresaTelefono`	String	Teléfono de contacto de la empresa, si está configurado.
`empresaEmail`	String	Correo electrónico de contacto de la empresa, si está configurado.
`empresaDireccion`	String	Contiene la dirección de la empresa asociada a la cuenta.
`empresaGeolocalizacion`	String	Contiene la geolocalización de la empresa asociada a la cuenta.
`firma`	String	Contiene una firma asociada a la cuenta.
`logo`	String	Contiene la dirección URL de la imagen utilizada como logo de la cuenta.
`logoBase64`	String	Representación Base64 del logo de la empresa. Puede ser muy extensa; evita registrarla o almacenarla si no es indispensable.
`jsonConfiguracion`	String	Configuración adicional de la cuenta serializada como JSON.
`avatar`	String	Contiene la dirección URL de la imagen utilizada como avatar para la cuenta.
`tkSesion`	String	Token de sesión para autenticar solicitudes posteriores. Es secreto: no lo expongas, compartas ni registres.
`expiracion`	Datetime	Contiene un formato compuesto por fecha y hora que indica la fecha de expiración para el token de sesión, antes de volver a realizar otro login.
`demo`	Integer	Indica si la cuenta es de demostración (1) o no (0).
`fechaCreacion`	Datetime	Contiene la fecha y hora de creación de la cuenta.
`expiracionCuenta`	Datetime	Contiene la fecha y hora de expiración de la cuenta.
`nivel`	Integer	Nivel de la cuenta.
`smsDisponibles`	Integer	Número de mensajes de texto disponibles.
`configuracionEmpresa`	Object	Contiene configuraciones específicas de la empresa.
`idPais`	String	Contiene el ID del país asociado a la cuenta.
`idEstado`	String	Contiene el ID del estado asociado a la cuenta.
`verSistema`	Integer	Indica si se puede visualizar el sistema (1) o no (0).
`loginF3`	Integer	Indica si se puede realizar login con el botón F3 (1) o no (0).
`loginF4`	Integer	Indica si se puede realizar login con el botón F4 (1) o no (0).
`idVersion`	Integer	Versión de la cuenta.
`idGmt`	Integer	ID del GMT asociado a la cuenta.
`offsetGmt`	Integer	Offset del GMT asociado a la cuenta.
`tkComision`	String	Token de comisión asociado a la cuenta, que puede ser nulo.
`linkTelefonoFijo`	String	Enlace para llamar al teléfono fijo asociado a la cuenta.
`linkTelefonoMovil`	String	Enlace para llamar al teléfono móvil asociado a la cuenta.
`linkMovil`	String	Enlace para llamar al número de teléfono móvil asociado a la cuenta.
`url`	String	URL asociada a la cuenta.
`idPaisEmpresa`	String	ID del país de la empresa asociada a la cuenta.
`idEstadoEmpresa`	String	ID del estado de la empresa asociada a la cuenta.
`idMunicipioEmpresa`	Integer	ID del municipio de la empresa asociada a la cuenta.
`calleEmpresa`	String	Calle de la empresa asociada a la cuenta.
`coloniaEmpresa`	String	Colonia de la empresa asociada a la cuenta.
`ciudadEmpresa`	String	Ciudad de la empresa asociada a la cuenta.
`codigoPostalEmpresa`	String	Código postal de la empresa asociada a la cuenta.
`latitudEmpresa`	String	Latitud de la empresa asociada a la cuenta.
`longitudEmpresa`	String	Longitud de la empresa asociada a la cuenta.
`idioma`	String	Idioma utilizado en la cuenta.
`temaVisual`	String	Tema visual utilizado en la cuenta.
`aspectoVisual`	String	Aspecto visual utilizado en la cuenta.
`fuente`	String	Fuente utilizada en la cuenta.
`bloquearNotificaciones`	Integer	Indica si se bloquean las notificaciones (1) o no (0).
`fondo`	String	Fondo utilizado en la cuenta.
`cambiarFondo`	Integer	Indica si se puede cambiar el fondo (1) o no (0).
`notificacionSonora`	Integer	Indica si hay notificación sonora (1) o no (0).
`ocultarCamposVacios`	Integer	Indica si se ocultan los campos vacíos (1) o no (0).
`idMonedaDefault`	String	ID de la moneda predeterminada asociada a la cuenta.
`configuracionApp`	Object	Contiene configuraciones específicas de la aplicación.
`estadoMailConfig`	Integer	Estado de la configuración del correo electrónico.
`normalizarMovil`	Integer	Indica si se normalizan los números móviles (1) o no (0).
`separarApellidos`	Integer	Indica si los apellidos se gestionan por separado (1) o no (0).
`validarCorreo`	Integer	Indica si está habilitada la validación de correo (1) o no (0).
`creditosCuenta`	Array<Object>	Saldos de crédito disponibles para la cuenta por tipo de crédito.
`creditosCuenta[].idTipoCredito`	Integer	Identificador del tipo de crédito.
`creditosCuenta[].saldo`	Number	Saldo disponible para el tipo de crédito.
`creditosCuenta[].alertaCredito`	Integer	Indica si hay alerta para el tipo de crédito (1) o no (0).
`alertaVencimiento`	Integer	Indica si se muestra una alerta de vencimiento (1) o no (0).
`2FA`	Integer	Indica si la cuenta tiene habilitada la autenticación de dos factores (1) o no (0).
`sistemaTelefonia`	Integer	Identificador del sistema de telefonía configurado para la cuenta.
`deviceId`	String	Identificador del dispositivo asociado a la sesión, que puede ser nulo.
`gotoRecordingChannelId`	String	Identificador del canal de grabación configurado, que puede ser nulo.

Solicitud

curl --request POST \
  --url 'https://api.upnify.com/login?usuario=usuario%40gmail.com&contrasenia=Contrasenia_Fuerte' \
  --header 'User-Agent: integracion-upnify/1.0'const iniciarSesion = async () => {
  const params = new URLSearchParams({
    usuario: "usuario@gmail.com",
    contrasenia: "Contrasenia_Fuerte",
  });
  const response = await fetch("https://api.upnify.com/login?" + params, {
    method: "POST",
  });
  return response.json();
};

iniciarSesion().then((sesion) => console.log(sesion));const iniciarSesion = async () => {
  const params = new URLSearchParams({
    usuario: "usuario@gmail.com",
    contrasenia: "Contrasenia_Fuerte",
  });
  const response = await fetch("https://api.upnify.com/login?" + params, {
    method: "POST",
  });
  return response.json();
};

iniciarSesion().then((sesion) => console.log(sesion));import requests

response = requests.post(
    "https://api.upnify.com/login",
    params={
        "usuario": "usuario@gmail.com",
        "contrasenia": "Contrasenia_Fuerte",
    },
)
response.raise_for_status()
sesion = response.json()package main

import (
  "encoding/json"
  "net/http"
  "net/url"
)

func main() {
  params := url.Values{
    "usuario": {"usuario@gmail.com"},
    "contrasenia": {"Contrasenia_Fuerte"},
  }
  request, _ := http.NewRequest(http.MethodPost, "https://api.upnify.com/login?"+params.Encode(), nil)
  response, _ := http.DefaultClient.Do(request)
  defer response.Body.Close()

  var sesion []map[string]any
  json.NewDecoder(response.Body).Decode(&sesion)
}using System.Net.Http;

var usuario = Uri.EscapeDataString("usuario@gmail.com");
var contrasenia = Uri.EscapeDataString("Contrasenia_Fuerte");
var url = $"https://api.upnify.com/login?usuario={usuario}&contrasenia={contrasenia}";

using var client = new HttpClient();
using var response = await client.PostAsync(url, null);
response.EnsureSuccessStatusCode();
var sesion = await response.Content.ReadAsStringAsync();

Respuesta

[
  {
    "bucket": 10001,
    "tkEmpresa": "00000000-0000-4000-8000-000000000001",
    "tkUsuario": "00000000-0000-4000-8000-000000000002",
    "tkGrupo": "00000000-0000-4000-8000-000000000003",
    "nombre": "Usuario",
    "apellidos": "De Prueba",
    "email": "usuario@gmail.com",
    "empresa": "Empresa de Ejemplo",
    "tkSesion": "00000000-0000-4000-8000-000000000004",
    "expiracion": "2030-01-02T03:04:05.000Z",
    "nivel": 1,
    "verSistema": 1,
    "2FA": 0,
    "creditosCuenta": [
      {
        "idTipoCredito": 1,
        "saldo": 100,
        "alertaCredito": 0
      }
    ]
  }
]

Inicio de sesión

Parámetros

Respuesta

Solicitud

Iniciar sesión

Respuesta

Respuesta exitosa