Qué es una instancia
Una instancia es una cuenta de Shalom Pro conectada a la API. Las credenciales son las del cliente final y se guardan cifradas para operar en su nombre: tú nunca gestionas su sesión a mano.
Instancias (sesión Shalom Pro)
Última actualización: 2026-09-21 · Base URL: https://api.shalom-api.lat
Una instancia representa una cuenta Shalom Pro conectada. La plataforma mantiene su sesión de forma persistente (login con navegador headless + cookies) y hace auto-login cuando expira si guardaste credenciales. La creación de envíos requiere una instancia activa con su instanceId.
POST
/instancesCrear nueva instancia
Crea una nueva instancia para el usuario autenticado con su API Key. No consume cuota.
| Parámetro | Descripción |
|---|---|
| name | Nombre descriptivo de la instancia (ej. Sucursal Principal). |
{
"name": "Mi Instancia"
}Respuesta (ejemplo)
{
"status": "created",
"instanceId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "Mi Instancia",
"message": "Instance created successfully"
}Nota: Devuelve 403 si tu plan tiene límite de instancias y lo alcanzaste.
GET
/instancesListar instancias
Devuelve todas las instancias pertenecientes al usuario de la API Key proporcionada. No consume cuota.
curl -X GET "https://api.shalom-api.lat/instances" \
-H "x-api-key: TU_API_KEY"Respuesta (ejemplo)
{
"instances": [
{
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "Mi Instancia",
"username": "[email protected]",
"createdAt": "2026-08-01T10:30:00.000Z",
"isLoggedIn": true
}
]
}DELETE
/instancesEliminar instancia
Elimina la instancia y su sesión persistida del sistema. Requiere API key de instancia. No consume cuota.
| Parámetro | Descripción |
|---|---|
| instanceId* | ID de la instancia (en el body). |
{
"instanceId": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}Respuesta (ejemplo)
{
"status": "closed",
"message": "Instance closed successfully"
}POST
/instances/statusShalom ProObtener estado de sesión
Verifica si la instancia está logueada en Shalom Pro. No consume cuota.
| Parámetro | Descripción |
|---|---|
| instanceId* | ID de la instancia (en el body). |
{
"instanceId": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}Respuesta (ejemplo)
{
"isLoggedIn": true,
"username": "[email protected]",
"url": "https://pro.shalom.pe"
}POST
/instances/loginShalom ProIniciar sesión en Shalom Pro
Realiza el login en pro.shalom.pe con navegador headless (resuelve reCAPTCHA v3). Las credenciales se guardan para auto-login futuro. No consume cuota.
| Parámetro | Descripción |
|---|---|
| instanceId* | ID de la instancia. |
| username* | Usuario/Email para iniciar sesión. |
| password* | Contraseña del usuario. |
{
"instanceId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"username": "[email protected]",
"password": "••••••••"
}Respuesta (ejemplo)
{
"success": true,
"message": "Login successful",
"url": "https://pro.shalom.pe"
}POST
/instances/logoutShalom ProCerrar sesión en Shalom Pro
Cierra la sesión de Shalom Pro y limpia la sesión persistida (incluye credenciales guardadas). No consume cuota.
| Parámetro | Descripción |
|---|---|
| instanceId* | ID de la instancia (en el body). |
{
"instanceId": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}Respuesta (ejemplo)
{
"success": true,
"message": "Logged out and session cleared"
}Crear y conectar
POST /instances crea la instancia con un nombre para identificarla, y POST /instances/login abre la sesión con el usuario y la contraseña de Shalom Pro. A partir de ahí, las operaciones Pro piden el instanceId.
Comprobar la sesión antes de operar
POST /instances/status dice si la sesión sigue viva. Conviene llamarlo antes de un lote grande: si expiró, el registro falla completo y te enteras tarde.
Una instancia por cliente
Si gestionas varias tiendas o clientes, usa una instancia para cada uno. Así las guías y el consumo quedan separados, y una sesión caída no arrastra a las demás.
El plan pone el límite
La cantidad de instancias depende de tu plan. Si intentas crear una de más, la API responde 403 indicando que alcanzaste el límite.
Errores de esta sección
| 403 | Tu plan tiene límite de instancias y lo alcanzaste (POST /instances). |
| 401 | La API key de instancia es inválida o la sesión expiró sin credenciales guardadas. |
Preguntas frecuentes
¿Qué credenciales usa una instancia de Shalom Pro?
Las de la cuenta de Shalom Pro del cliente final. Se almacenan cifradas para operar en su nombre.
¿Cómo sé si la sesión de Shalom Pro sigue activa?
Con POST /instances/status, enviando el instanceId.
¿Qué hago si la sesión expiró?
Volver a iniciarla con POST /instances/login y reintentar la operación.
¿Puedo tener varias instancias?
Sí, y lo recomendable es una por cliente. El plan puede limitar cuántas puedes crear.
¿Cómo elimino una instancia?
Con DELETE /instances, enviando el instanceId en el cuerpo de la petición.
Continúa con
¿Aún no tienes API key?
Escríbenos por WhatsApp y la recibes de inmediato para probar todos estos ejemplos.
Solicitar API key