Flujo de integración
Conoce el recorrido completo para integrar tu sistema con el API de Adm Cloud, desde la creación de la integración hasta la interpretación de la respuesta.
Este es el recorrido que debe seguir un desarrollador para integrar su sistema con el API de Adm Cloud.
🧩 Paso 1: Crear una integración
Antes de llamar al API, necesitas una integración creada en Adm Cloud, desde donde obtendrás tu AppID.
Ya vimos el detalle completo en Autenticación y seguridad.
🔐 Paso 2: Autenticarte
Elige uno de los dos métodos disponibles:
- Básica: envías usuario/contraseña en cada llamada junto con
company,roleyappid. - Token (recomendada): haces un
POSTa/api/Tokencon tus credenciales de Adm Cloud (Basic Auth) y los parámetrosCompany,RoleIDyAppId. El token queda en el campodatade la respuesta y es válido por 24 horas.
El detalle completo de ambos métodos está en Autenticación y seguridad.
📡 Paso 3: Llamar a un endpoint
Con tus credenciales listas, ya puedes consumir cualquier endpoint del API. Ejemplo: obtener un listado de clientes.
- Endpoint:
/api/Customers - Método:
GET
Opción A: Usando Autenticación Básica
Parámetros: company, role, appid, más tu usuario y contraseña en el header Authorization.
curl -u "[email protected]:contraseña" \
"https://api.admcloud.net/api/Customers?skip=0&company=demo&role=administradores&appid=378d0208-6942-4bc6-a880-2c9b1229610f"var api_base = "https://api.admcloud.net/api/";
var url = $"Customers?skip=0&company={company}&role={role}&appid={appid}";
var header = Convert.ToBase64String(
System.Text.ASCIIEncoding.ASCII.GetBytes($"{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);Opción B: Usando Token
Una vez que tienes tu token (Paso 2), lo envías como parámetro token en la URL — ya no necesitas enviar usuario y contraseña.
curl "https://api.admcloud.net/api/Customers?skip=0&token=eyJhbGciOiJIUzI1NiIs..."var api_base = "https://api.admcloud.net/api/";
var token = "eyJhbGciOiJIUzI1NiIs...";
var url = $"Customers?skip=0&token={token}";
var client = new HttpClient();
client.BaseAddress = new Uri(api_base);
var json = await client.GetStringAsync(url);El parámetro
skipcontrola la paginación del listado.
📥 Paso 4: Interpretar la respuesta
El API devuelve la información solicitada en formato JSON, junto con un código de estado HTTP que indica si la operación fue exitosa o no.
{
"status": "success",
"data": [
{ "id": 1, "nombre": "Juan" }
]
}Los distintos tipos de operaciones (GET, POST, PUT, DELETE) y el manejo de errores los vemos en detalle en Tipos de operaciones y manejo de errores.
🧠 Resumen del flujo
| Paso | Acción | Requiere integración creada | Requiere autenticación |
|---|---|---|---|
| 1 | Crear integración | — | — |
| 2 | Autenticarte | ✅ Sí | — |
| 3 | Llamar a un endpoint | ✅ Sí | ✅ Sí |
| 4 | Interpretar la respuesta | ✅ Sí | ✅ Sí |
Updated about 3 hours ago
