Acceso y conexión

Para utilizar las APIs de ZetaSoftware es necesario contar con la habilitación correspondiente y con los datos de conexión requeridos. Estos datos permiten identificar al desarrollador, la empresa y el usuario que realizará las operaciones mediante la API.


Modelo de credenciales

Campo Tipo Origen Descripción
DesarrolladorCodigo String ZetaSoftware Identificador único del desarrollador o integrador. Invariante respecto a la empresa cliente.
DesarrolladorClave String ZetaSoftware Clave secreta del desarrollador. Se entrega de forma confidencial junto con DesarrolladorCodigo.
EmpresaCodigo String Empresa cliente Identificador único de la empresa cuyos datos se van a operar.
EmpresaClave String Empresa cliente Clave generada individualmente para cada par Desarrollador–Empresa. Se configura en Configuración > APIs dentro del sistema.
RolCodigo String Empresa cliente Código de un rol existente y activo en la empresa. El sistema únicamente valida existencia y estado activo; no evalúa permisos granulares sobre los recursos. Valor recomendado: 1.
UsuarioCodigo No utilizado. No debe enviarse con valor.
UsuarioClave No utilizado. No debe enviarse con valor.

Credenciales del desarrollador

El desarrollador debe solicitar sus credenciales directamente a ZetaSoftware completando el formulario de registro disponible a través de soporte@zetasoftware.com.

ZetaSoftware proveerá DesarrolladorCodigo y DesarrolladorClave de forma directa y confidencial. Estas credenciales son estáticas por defecto y pueden modificarse únicamente a solicitud explícita del desarrollador.

Credenciales de la empresa cliente

EmpresaCodigo y EmpresaClave deben ser provistos por la empresa contratante. La clave se genera de forma individualizada para cada par Desarrollador–Empresa desde Configuración > APIs en el sistema ZetaSoftware.

RolCodigo también debe ser suministrado por la empresa. Debe corresponder a un rol existente en Configuración > Roles de Usuario con estado Activo.


Datos de conexión

Los métodos de las APIs utilizan un bloque llamado Connection. Dentro de este bloque se informan los datos necesarios para autenticar la conexión y determinar sobre qué empresa se operará.

Ejemplo general:

{
  "Connection": {
    "DesarrolladorCodigo": "string",
    "DesarrolladorClave": "string",
    "EmpresaCodigo": "string",
    "EmpresaClave": "string",
    "UsuarioCodigo": 0,
    "UsuarioClave": "string",
    "RolCodigo": 0
  }
}

Estos datos deben enviarse en cada request, de acuerdo con la estructura indicada en la documentación de cada API.


Observaciones importantes

  • Validación de RolCodigo: el sistema verifica únicamente que el rol exista y esté activo en la empresa. No se evalúan permisos específicos sobre recursos. Para evitar errores por modificaciones futuras al rol, se recomienda
    usar RolCodigo = 1, que permanece siempre activo.
  • Alcance de las credenciales del desarrollador:
    DesarrolladorCodigo y DesarrolladorClave son independientes de la empresa cliente. Un mismo par de credenciales de desarrollador puede operar contra múltiples empresas.
  • Campos no utilizados: UsuarioCodigo y UsuarioClave están reservados pero no tienen uso activo. Deben omitirse
    o enviarse vacíos; no deben contener valores operativos.
  • Confidencialidad: las claves (DesarrolladorClave y EmpresaClave) no deben exponerse en código fuente accesible públicamente ni transmitirse por canales no seguros.

Errores frecuentes de acceso

Si la conexión no funciona, se debe revisar:

Situación Posible causa
No permite conectar Credenciales de desarrollador incorrectas.
No reconoce la empresa EmpresaCodigo o EmpresaClave incorrectos.
No permite opera Usuario o rol sin permisos suficientes.
Error de autenticación Algún dato del bloque Connection es incorrecto o está vacío.

Si el error continúa, se debe enviar a soporte@zetasoftware.com el mensaje exacto que devuelve la API, junto con el método utilizado y el body enviado.

Compartir

Acceso y conexión

O copia el enlace

CONTENIDO