Ir al contenido

Referencia · General

Validar credenciales

POST/validarCredenciales

Verifica que el par x-api-key / x-api-secret sea válido y devuelve los datos no sensibles de la empresa asociada. Recomendado como primer paso al integrar.

La guía correspondiente está en Credenciales.

La ruta POST /validarCredenciales se agrega a la URL base del ambiente.

Enviá los headers x-api-key y x-api-secret. Cómo obtenerlos está en Credenciales.

No lleva cuerpo.

Este endpoint no recibe campos.

Credenciales válidas

Si la operación sale bien, codigoError viene vacío.

Campo Tipo Obligatorio Descripción Ejemplo
descripcion string Sí — —
codigoError string Sí — —
rut string Sí RUT de la empresa autenticada. —
nombreEmpresa string Sí Nombre de la empresa autenticada. —

Una respuesta de error trae codigoError y descripcion. El mismo código puede significar cosas distintas según el endpoint. El índice completo está en Códigos de error.

Si fallan las credenciales o el formato del body, aplican los códigos comunes: A01 a A06, V01 y V02.

Credenciales inválidas

{
"descripcion": "API key inválida o inactiva",
"codigoError": "A02",
"rut": "",
"nombreEmpresa": ""
}

Este endpoint no lleva cuerpo.