Autenticación y seguridad

Aprende cómo autenticarte en el API de Adm Cloud, qué credenciales necesitas y cómo proteger correctamente tus llamadas.

El API de Adm Cloud soporta dos formas de autenticación:

  • Autenticación Básica
  • Autenticación por Token (recomendada)

Ambas requieren que primero exista una integración creada en Adm Cloud.


🧩 Antes de empezar: crea una integración

Para poder autenticarte, primero necesitas una integración configurada dentro de Adm Cloud.

Ve a Configuración > Personalización > Integraciones con Web Services y crea una nueva integración, indicando:

  • Descripción: nombre que identificará la integración
  • Observaciones: información adicional sobre su uso o propósito
  • Ejecutar como Administradores: desmárcala si los usuarios que usarán la integración no pertenecen al grupo de administradores

Al guardar, Adm Cloud genera un AppID único para esa integración. Lo necesitarás en ambos métodos de autenticación.


🔑 Autenticación Básica

Usa los valores de Company, Role y AppID, junto con tu usuario y contraseña de Adm Cloud.

ParámetroQué es
companyID de la empresa configurada en la integración
appidID de la integración creada
roleNombre del grupo de usuarios asignado (Configuración > Seguridad > Grupos de Usuarios)

Las credenciales se envían mediante Basic Authentication, codificando usuario y contraseña en el encabezado Authorization.

Ejemplo en C#:

var api_base = "https://api.admcloud.net/api/";
var appid = "your appid";
var company = "your company";
var role = "your role";
var url = $"Customers?&skip=0&appid={appid}&company={company}&role={role}";

var header = Convert.ToBase64String(
    System.Text.ASCIIEncoding.ASCII.GetBytes(
        string.Format("{0}:{1}", email, password)));

var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", header);
client.BaseAddress = new Uri(api_base);

var json = await client.GetStringAsync(url);

🔄 Autenticación por Token (recomendada)

Este método evita enviar usuario y contraseña en cada llamada. En su lugar, obtienes un token temporal una sola vez y lo usas en todas las llamadas posteriores.

ParámetroQué es
companyID de la empresa configurada en la integración
appidID de la integración creada
roleDescripción del grupo de usuarios asignado
roleIdGuid del grupo de usuarios asignado

Pasos:

  1. Llama al endpoint de Login con tus credenciales y los parámetros anteriores.
  2. Si la autenticación es exitosa, recibirás un token en la respuesta.
  3. Usa ese token en cada llamada posterior al API.

El token tiene una validez de 24 horas. Al expirar, simplemente repite el proceso de login para obtener uno nuevo.


🔓 Ventajas de usar Token en lugar de Básica

  • Mayor seguridad en las integraciones
  • Evitas enviar usuario y contraseña en cada llamada
  • Control más eficiente del acceso

🔐 Consideraciones de seguridad

  • Todas las llamadas al API deben realizarse sobre HTTPS.
  • No compartas tus credenciales, AppID ni tokens con terceros no autorizados.
  • Si usas Autenticación Básica, evita enviar usuario y contraseña desde el cliente final (navegador o app móvil); hazlo desde tu servidor.
  • Si el token expira, simplemente solicita uno nuevo — no reutilices tokens vencidos.

Puedes ver el detalle completo de cada endpoint de autenticación en el API Reference.



Did this page help you?